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.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.connected

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

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.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.added

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.converted_to_unmanaged`

A managed device was successfully converted to an unmanaged device.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.converted_to_unmanaged

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

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.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_errors

Array

Errors associated with the connected account.

connected_account_id

String (UUID)

ID of the connected account associated with the event.

connected_account_warnings

Array

Warnings associated with the connected account.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_errors

Array

Errors associated with the device.

device_id

String (UUID)

ID of the affected device.

device_warnings

Array

Warnings associated with the device.

error_code

Enum (String)

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

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.disconnected

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

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.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.tampered

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.low_battery`

A device battery level dropped below the low threshold.

Example webhook payload

{
  "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_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

battery_level

number

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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.low_battery

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

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.

Example webhook payload

{
  "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_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

battery_level

number

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

battery_status

Enum (String)

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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.battery_status_changed

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.removed`

A device was removed externally from the connected account.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.removed

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.deleted`

A device was deleted.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

device_name

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.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.deleted

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

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.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.third_party_integration_detected

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

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.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.third_party_integration_no_longer_detected

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.salto.privacy_mode_activated`

A Salto device activated privacy mode.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.salto.privacy_mode_activated

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.salto.privacy_mode_deactivated`

A Salto device deactivated privacy mode.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.salto.privacy_mode_deactivated

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.connection_became_flaky`

Seam detected a flaky device connection.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_errors

Array

Errors associated with the connected account.

connected_account_id

String (UUID)

ID of the connected account associated with the event.

connected_account_warnings

Array

Warnings associated with the connected account.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_errors

Array

Errors associated with the device.

device_id

String (UUID)

ID of the affected device.

device_warnings

Array

Warnings associated with the device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.connection_became_flaky

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.connection_stabilized`

Seam detected that a previously-flaky device connection stabilized.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.connection_stabilized

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

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.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_errors

Array

Errors associated with the connected account.

connected_account_id

String (UUID)

ID of the connected account associated with the event.

connected_account_warnings

Array

Warnings associated with the connected account.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_errors

Array

Errors associated with the device.

device_id

String (UUID)

ID of the affected device.

device_warnings

Array

Warnings associated with the device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.error.subscription_required

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

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.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.error.subscription_required.resolved

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.accessory_keypad_connected`

An accessory keypad was connected to a device.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.accessory_keypad_connected

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.accessory_keypad_disconnected`

An accessory keypad was disconnected from a device.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_errors

Array

Errors associated with the connected account.

connected_account_id

String (UUID)

ID of the connected account associated with the event.

connected_account_warnings

Array

Warnings associated with the connected account.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_errors

Array

Errors associated with the device.

device_id

String (UUID)

ID of the affected device.

device_warnings

Array

Warnings associated with the device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.accessory_keypad_disconnected

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.name_changed`

The name of a device was changed.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

device_name

String

The new name of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.name_changed

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`camera.activated`

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

Example webhook payload

{
  "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_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

activation_reason

Enum (String)

The reason the camera was activated.Possible values: motion_detected

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: camera.activated

image_url

String

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

motion_sub_type

Enum (String)

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

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

video_url

String

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

workspace_id

String (UUID)

ID of the workspace associated with the event.

`device.doorbell_rang`

A doorbell button was pressed on a device.

Example webhook payload

{
  "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_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

connected_account_custom_metadata

Object

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

connected_account_id

String (UUID)

ID of the connected account associated with the event.

created_at

String (ISO 8601)

Date and time at which the event was created.

customer_key

String

The customer key associated with the device, if any.

device_custom_metadata

Object

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

device_id

String (UUID)

ID of the affected device.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: device.doorbell_rang

image_url

String

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

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

video_url

String

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

workspace_id

String (UUID)

ID of the workspace associated with the event.

​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`