Device Events

`device.connected`

The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "The status of a device changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.connected",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.connected

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.added`

A device was added to Seam or was re-added to Seam after having been removed.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A device was added to Seam or was re-added to Seam after having been removed.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.added",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.added

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.converted_to_unmanaged`

A managed device was successfully converted to an unmanaged device.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A managed device was successfully converted to an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices).",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.converted_to_unmanaged",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.converted_to_unmanaged

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.disconnected`

The status of a device changed from online to offline. That is, the device.properties.online property changed from true to false.

{
  "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",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_errors": [],
  "device_id": "00000000-0000-0000-0000-000000000000",
  "device_warnings": [],
  "error_code": "account_disconnected",
  "event_description": "The status of a device changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.disconnected",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

Array

Errors associated with the connected account.

String (UUID)

ID of the connected account associated with the event.

Array

Warnings associated with the connected account.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

Array

Errors associated with the device.

String (UUID)

ID of the affected device.

Array

Warnings associated with the device.

Enum (String)

Error code associated with the disconnection event, if any.Possible values: account_disconnected, hub_disconnected, device_disconnected

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)

ID of the event.

Enum (String)

Value: device.disconnected

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.tampered`

A device detected that it was tampered with, for example, opened or moved.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A device detected that it was tampered with, for example, opened or moved.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.tampered",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.tampered

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.low_battery`

A device battery level dropped below the low threshold.

{
  "battery_level": 0,
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A device battery level dropped below the low threshold.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.low_battery",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

number

Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.low_battery

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.battery_status_changed`

A device battery status changed since the last battery_status_changed event.

{
  "battery_level": 0,
  "battery_status": "critical",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A device battery status changed since the last `battery_status_changed` event.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.battery_status_changed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

number

Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.

Enum (String)

Battery status of the affected device, calculated from the numeric battery_level value.Possible values: critical, low, good, full

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.battery_status_changed

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.removed`

A device was removed externally from the connected account.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A device was removed externally from the connected account.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.removed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.removed

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.deleted`

A device was deleted.

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

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

String

Name of the deleted device, captured at deletion time. The device record no longer exists when this event fires, so the name is preserved here. Null when the device had no resolvable name.

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)

ID of the event.

Enum (String)

Value: device.deleted

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.third_party_integration_detected`

Seam detected that a device is using a third-party integration that will interfere with Seam device management.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "Seam detected that a device is using a third-party integration that will interfere with Seam device management.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.third_party_integration_detected",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.third_party_integration_detected

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.third_party_integration_no_longer_detected`

Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.third_party_integration_no_longer_detected",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.third_party_integration_no_longer_detected

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.salto.privacy_mode_activated`

A Salto device activated privacy mode.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A [Salto device](/device-and-system-integration-guides/salto-locks) activated privacy mode.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.salto.privacy_mode_activated",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.salto.privacy_mode_activated

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.salto.privacy_mode_deactivated`

A Salto device deactivated privacy mode.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A [Salto device](/device-and-system-integration-guides/salto-locks) deactivated privacy mode.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.salto.privacy_mode_deactivated",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.salto.privacy_mode_deactivated

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.connection_became_flaky`

Seam detected a flaky device connection.

{
  "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",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_errors": [],
  "device_id": "00000000-0000-0000-0000-000000000000",
  "device_warnings": [],
  "event_description": "Seam detected a flaky device connection.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.connection_became_flaky",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

Array

Errors associated with the connected account.

String (UUID)

ID of the connected account associated with the event.

Array

Warnings associated with the connected account.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

Array

Errors associated with the device.

String (UUID)

ID of the affected device.

Array

Warnings associated with the device.

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)

ID of the event.

Enum (String)

Value: device.connection_became_flaky

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.connection_stabilized`

Seam detected that a previously-flaky device connection stabilized.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "Seam detected that a previously-flaky device connection stabilized.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.connection_stabilized",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.connection_stabilized

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.error.subscription_required`

A third-party subscription is required to use all device features.

{
  "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",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_errors": [],
  "device_id": "00000000-0000-0000-0000-000000000000",
  "device_warnings": [],
  "event_description": "A third-party subscription is required to use all device features.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.error.subscription_required",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

Array

Errors associated with the connected account.

String (UUID)

ID of the connected account associated with the event.

Array

Warnings associated with the connected account.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

Array

Errors associated with the device.

String (UUID)

ID of the affected device.

Array

Warnings associated with the device.

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)

ID of the event.

Enum (String)

Value: device.error.subscription_required

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.error.subscription_required.resolved`

A third-party subscription is active or no longer required to use all device features.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A third-party subscription is active or no longer required to use all device features.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.error.subscription_required.resolved",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.error.subscription_required.resolved

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.accessory_keypad_connected`

An accessory keypad was connected to a device.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An accessory keypad was connected to a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.accessory_keypad_connected",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.accessory_keypad_connected

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.accessory_keypad_disconnected`

An accessory keypad was disconnected from a device.

{
  "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",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_errors": [],
  "device_id": "00000000-0000-0000-0000-000000000000",
  "device_warnings": [],
  "event_description": "An accessory keypad was disconnected from a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.accessory_keypad_disconnected",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

Array

Errors associated with the connected account.

String (UUID)

ID of the connected account associated with the event.

Array

Warnings associated with the connected account.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

Array

Errors associated with the device.

String (UUID)

ID of the affected device.

Array

Warnings associated with the device.

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)

ID of the event.

Enum (String)

Value: device.accessory_keypad_disconnected

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`device.name_changed`

The name of a device was changed.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "device_name": "",
  "event_description": "The name of a device was changed.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.name_changed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

String

The new name of the affected device.

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)

ID of the event.

Enum (String)

Value: device.name_changed

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`camera.activated`

A camera was activated, for example, by motion detection.

{
  "activation_reason": "motion_detected",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A camera was activated, for example, by motion detection.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "camera.activated",
  "image_url": "",
  "motion_sub_type": "human",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "video_url": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Enum (String)

The reason the camera was activated.Possible values: motion_detected

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: camera.activated

String

URL to a thumbnail image captured at the time of activation.

Enum (String)

Sub-type of motion detected, if available.Possible values: human, vehicle, package, other

String (ISO 8601)

Date and time at which the event occurred.

String

URL to a short video clip captured at the time of activation.

String (UUID)

ID of the workspace associated with the event.

`device.doorbell_rang`

A doorbell button was pressed on a device.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A doorbell button was pressed on a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "device.doorbell_rang",
  "image_url": "",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "video_url": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

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

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

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)

ID of the event.

Enum (String)

Value: device.doorbell_rang

String

URL to a thumbnail image captured at the time the doorbell was pressed.

String (ISO 8601)

Date and time at which the event occurred.

String

URL to a short video clip captured at the time the doorbell was pressed.

String (UUID)

ID of the workspace associated with the event.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Device Events

`device.connected`

`device.added`

`device.converted_to_unmanaged`

`device.disconnected`

`device.tampered`

`device.low_battery`

`device.battery_status_changed`

`device.removed`

`device.deleted`

`device.third_party_integration_detected`

`device.third_party_integration_no_longer_detected`

`device.salto.privacy_mode_activated`

`device.salto.privacy_mode_deactivated`

`device.connection_became_flaky`

`device.connection_stabilized`

`device.error.subscription_required`

`device.error.subscription_required.resolved`

`device.accessory_keypad_connected`

`device.accessory_keypad_disconnected`

`device.name_changed`

`camera.activated`

`device.doorbell_rang`

​device.connected

​device.added

​device.converted_to_unmanaged

​device.disconnected

​device.tampered

​device.low_battery

​device.battery_status_changed

​device.removed

​device.deleted

​device.third_party_integration_detected

​device.third_party_integration_no_longer_detected

​device.salto.privacy_mode_activated

​device.salto.privacy_mode_deactivated

​device.connection_became_flaky

​device.connection_stabilized

​device.error.subscription_required

​device.error.subscription_required.resolved

​device.accessory_keypad_connected

​device.accessory_keypad_disconnected

​device.name_changed

​camera.activated

​device.doorbell_rang

`device.connected`

`device.added`

`device.converted_to_unmanaged`

`device.disconnected`

`device.tampered`

`device.low_battery`

`device.battery_status_changed`

`device.removed`

`device.deleted`

`device.third_party_integration_detected`

`device.third_party_integration_no_longer_detected`

`device.salto.privacy_mode_activated`

`device.salto.privacy_mode_deactivated`

`device.connection_became_flaky`

`device.connection_stabilized`

`device.error.subscription_required`

`device.error.subscription_required.resolved`

`device.accessory_keypad_connected`

`device.accessory_keypad_disconnected`

`device.name_changed`

`camera.activated`

`device.doorbell_rang`