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

The following sections list the properties for events pertaining to various types of resources:

Common Event Properties

Common Device Event Properties

In addition to the common event properties, the following properties are available for all events that pertain to devices:

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:

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:

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:

Device Battery Status Event Properties

In addition to the device battery event properties, the following properties are available for device.battery_status_changed events:

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:

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.

Event Types

List of Methods

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!