Displaying Device Health
You can display the health status of your end users' devices in your app.
Last updated
Was this helpful?
You can display the health status of your end users' devices in your app.
Last updated
Was this helpful?
To display the health—that is, the online/offline status—of your end users' devices in your app, you can use the following Seam mechanisms:
Seam polls connected devices and accounts every ten minutes and updates the Boolean device.properties.online property accordingly. Use a Get Device request to retrieve the current online/offline status of a device. Then, display the device status in your app.
Request:
Response:
When a device connection or disconnection occurs, Seam generates a device.connected or device.disconnected event, respectively. You can retrieve these events using a List Events request or through webhooks and then display the corresponding status in your app.
When issuing a List Events request to retrieve device.connected or device.disconnected events for a specific device, include the following parameters:
device_id
String (UUID)
ID of the device for which you want to retrieve device.connected or device.disconnected events
event_type
String
Event type that you want to retrieve, that is, device.connected or device.disconnected
since
String
Desired starting event generation date and time
You must include since or between.
between
Set of two strings
Desired starting and ending event generation dates and times
For example:
["2024-01-01T00:00:00Z", "2024-02-01T00:00:00Z"]
You must include between or since.
The following example uses the List Events request to retrieve all device.connected events for a specific device since January 1, 2024:
Request:
Response:
You can set up webhook endpoints to receive device.connected and device.disconnected events. Then, you can use the receipt of these events to display the corresponding device status in your app. For more information about configuring webhooks, see Webhooks.
