Events
Events let you know when something interesting happens in your workspace. When an interesting event occurs, Seam creates a new Event
object. For example, when a lock is unlocked, Seam creates a lock.unlocked
event. When a device's battery level is low, Seam creates a device.battery_low
event.
As with other API resources, you can use endpoints to retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event
objects directly to an endpoint on your sever. Manage webhooks through the Seam Console. For details, see Webhooks.
event
Properties
event
PropertiesThe following sections list the properties for events pertaining to various types of resources:
Common Event Properties
| String | Unique identifier for the |
| See Event Types. | Type of event. |
| String | Time at which the |
| String | Unique identifier for the |
| String | The unique identifier of the connected account to which this event pertains. |
Common Device Event Properties
In addition to the common event properties, the following properties are available for all events that pertain to devices:
| String | Unique identifier for the |
Access Code Event Properties
In addition to the common event properties and common device event properties, the following properties are available for events that pertain to access codes:
| String | Present on all of the |
| String | Only present on |
Lock Event Properties
In addition to the common event properties and common device event properties, the following properties are available for events that pertain to lock actions:
| Enum | Present on Supported values:
|
| String | Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information.
For a list of device manufacturers that send the |
Device Battery Event Properties
In addition to the common event properties and common device event properties, the following properties are available for device.low_battery
and device.battery_status_changed
events:
| Number (0-1) | Determines the battery level of the device. Only present on a |
Device Battery Status Event Properties
In addition to the device battery event properties, the following properties are available for device.battery_status_changed
events:
|
| Specifies the new battery status for the device. |
Device Disconnected Event Properties
In addition to the common event properties and common device event properties, the following properties are available for device.disconnected
events:
|
| Only present on a |
Noise Sensor Event Properties
Noise sensors emit an event whenever a predefined noise threshold has been exceeded. Seam tracks any noise thresholds that have been set in the user's app or built-in thresholds to the noise sensor. To see what thresholds are available, query /noise_sensors/noise_thresholds/list
.
| String | Identifier for the noise threshold, pass to |
| String e.g. | Name of the threshold, this can be set via |
Event Types
Event Name | Description |
---|---|
| An |
| An |
| For native scheduled codes (see Native Scheduling), this event is sent when an |
| An |
| A backup |
| An |
| Seam has deleted the access code because it is at the end of its lifecycle (it is not on the device and is not supposed to be active in the future) Future requests to this access_code will |
| There was a longer than expected delay in programming an access code onto a device. For time bound codes, this is sent when the code is not set by the |
| An error occurred in trying to program the code onto a device. This indicates a failure occurred but the failure might be temporary and may recover (in which case an |
| There was a longer than expected delay in removing an access code from a device. This is not necessarily a failure as the code might successfully be removed even after this event is sent. |
| An error occurred in trying to remove an access code from a device. This indicates a failure occurred but the failure might be temporary and may recover (in which case an |
| When we detect that an access code was modified external to Seam after we successfully set it on the device, we will send this event. |
| When we detect that an access code was deleted external to Seam after we successfully set it on the device, we will send this event. |
| Successfully converted an unmanaged access code to a managed access code. |
| Failed to converted an unmanaged access code to a managed access code. |
| An unmanaged |
| An unmanaged |
| A connected account has been imported into your Seam workspace. |
| Seam has established connection to or is reconnected to a connected account. |
| Seam has lost connection to a connected account. Please ask the account owner to sign in to their account through a new connect webview again. |
| A connected account has been deleted from your Seam workspace. |
| Seam has finished the first sync of a connected account and devices are now available. |
| A login using a Connect Webview was completed successfully. Sent even if the account was previously connected and a separate Connect Webview login was completed. |
| A login using a Connect Webview failed. |
| An accessory keypad has been connected to a device. |
| An accessory keypad has been disconnected from a device. |
| A device has come online. |
| A device has gone offline. |
| A user manually removed a device from their account, without using a Seam action. |
| A device was deleted from its connected account using the following Seam actions: |
| The battery level of the device drops below the low battery level threshold. |
| The battery status for the device has changed (for example, it changed from |
| A device detects that someone has opened up its case, or has moved the device. |
| A device connection has become flaky. |
| The privacy mode has been activated on the Salto device. |
| The privacy mode has been deactivated on the Salto device. |
| A third party integration has been detected on the device. |
| An unmanaged device has come online. |
| An unmanaged device has gone offline. |
| Successfully converted a managed device to an unmanaged device. |
| Successfully converted an unmanaged device to a managed device. |
| A door lock has been locked. |
| A door lock has been unlocked. |
| An incorrect access code was entered multiple times in a row on a device (Kwikset only). |
| The noise detected from a noise sensor exceeded a predefined threshold and/or duration. |
List of Methods
List and filter events | |
Get data for an individual event |
Testing Events
Use the Webhooks sandbox in the Seam Console to see the different payloads for each event and test them against your own endpoints!
Last updated