Connected Account Events

`connected_account.connected`

A connected account was connected for the first time or was reconnected after being disconnected.

{
  "connect_webview_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "event_description": "A connected account was connected for the first time or was reconnected after being disconnected.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "connected_account.connected",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String (UUID)

ID of the Connect Webview associated with the event.

Object (String, Boolean values)

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

required

ID of the affected connected account.

String (ISO 8601)

required

Date and time at which the event was created.

String

The customer key associated with this connected account, if any.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: connected_account.connected

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`connected_account.created`

A connected account was created.

{
  "connect_webview_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "A connected account was created.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "connected_account.created",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String (UUID)

required

ID of the Connect Webview associated with the event.

Object (String, Boolean values)

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

required

ID of the affected connected account.

String (ISO 8601)

required

Date and time at which the event was created.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: connected_account.created

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`connected_account.disconnected`

A connected account was disconnected.

{
  "connected_account_custom_metadata": {},
  "connected_account_errors": [],
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_warnings": [],
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "A connected account was disconnected.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "connected_account.disconnected",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object (String, Boolean values)

Custom metadata of the connected account, present when connected_account_id is provided.

Array of Objects

required

Errors associated with the connected account.

Show properties

String (ISO 8601)

required

Date and time at which Seam created the error.

String

required

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

String

required

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

String (UUID)

required

ID of the affected connected account.

Array of Objects

required

Warnings associated with the connected account.

Show properties

String (ISO 8601)

required

Date and time at which Seam created the warning.

String

required

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

String

required

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

String (ISO 8601)

required

Date and time at which the event was created.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: connected_account.disconnected

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`connected_account.completed_first_sync`

A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "connected_account.completed_first_sync",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object (String, Boolean values)

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

required

ID of the affected connected account.

String (ISO 8601)

required

Date and time at which the event was created.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: connected_account.completed_first_sync

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`connected_account.deleted`

A connected account was deleted.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "event_description": "A connected account was deleted.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "connected_account.deleted",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object (String, Boolean values)

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

required

ID of the affected connected account.

String (ISO 8601)

required

Date and time at which the event was created.

String

The customer key associated with this connected account, if any.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: connected_account.deleted

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`connected_account.completed_first_sync_after_reconnection`

A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "connected_account.completed_first_sync_after_reconnection",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object (String, Boolean values)

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

required

ID of the affected connected account.

String (ISO 8601)

required

Date and time at which the event was created.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: connected_account.completed_first_sync_after_reconnection

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`connected_account.reauthorization_requested`

A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.

{
  "connected_account_custom_metadata": {},
  "connected_account_errors": [],
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_warnings": [],
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "connected_account.reauthorization_requested",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object (String, Boolean values)

Custom metadata of the connected account, present when connected_account_id is provided.

Array of Objects

required

Errors associated with the connected account.

Show properties

String (ISO 8601)

required

Date and time at which Seam created the error.

String

required

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

String

required

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

String (UUID)

required

ID of the affected connected account.

Array of Objects

required

Warnings associated with the connected account.

Show properties

String (ISO 8601)

required

Date and time at which Seam created the warning.

String

required

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

String

required

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

String (ISO 8601)

required

Date and time at which the event was created.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: connected_account.reauthorization_requested

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Connected Account Events

`connected_account.connected`

`connected_account.created`

`connected_account.disconnected`

`connected_account.completed_first_sync`

`connected_account.deleted`

`connected_account.completed_first_sync_after_reconnection`

`connected_account.reauthorization_requested`