Comment on page
List Events
List event emitted within a users workspace
get
https://connect.getseam.com
/events/list
List Events
To programmatically access events, you can use
events.list
. This will return the same events that would be sent to a webhook, however events.list
allows you to filter or see events that already took place.Javascript
Python
Ruby
PHP
await seam.events.list()
/*
[
{
event_id: '87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2',
event_type: 'device.low_battery',
created_at: '2022-08-24T11:23:49.459Z',
device_id: 'a83690b2-2b70-409a-9a94-426699b84c97',
workspace_id: 'f97073eb-c003-467a-965b-e6dba3a0131d',
battery_level: 0.48
},
{
event_id: '2fc8d1bc-7b4d-4960-9aa4-7e6bf5dc5848',
event_type: 'device.low_battery',
created_at: '2022-08-24T11:23:49.335Z',
device_id: 'a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4',
workspace_id: 'f97073eb-c003-467a-965b-e6dba3a0131d',
battery_level: 0.48
}
]
*/
seam.events.list()
# [
# Event(
# event_id="87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2",
# event_type="device.low_battery",
# created_at="2022-08-24T11:23:49.459Z",
# device_id="a83690b2-2b70-409a-9a94-426699b84c97",
# workspace_id="f97073eb-c003-467a-965b-e6dba3a0131d",
# battery_level=0.48,
# )
# ]
seam.events.list
# [<Seam::Event:0x007cd58
# event_id="87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2",
# event_type="device.low_battery",
# created_at="2022-08-24T11:23:49.459Z",
# device_id="a83690b2-2b70-409a-9a94-426699b84c97",
# workspace_id="f97073eb-c003-467a-965b-e6dba3a0131d",
# battery_level=>0.48>]
$events = $seam->events->list();
echo json_encode($events)
/*
[
{
event_id: '87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2',
event_type: 'device.low_battery',
created_at: '2022-08-24T11:23:49.459Z',
device_id: 'a83690b2-2b70-409a-9a94-426699b84c97',
workspace_id: 'f97073eb-c003-467a-965b-e6dba3a0131d',
battery_level: 0.48
},
{
event_id: '2fc8d1bc-7b4d-4960-9aa4-7e6bf5dc5848',
event_type: 'device.low_battery',
created_at: '2022-08-24T11:23:49.335Z',
device_id: 'a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4',
workspace_id: 'f97073eb-c003-467a-965b-e6dba3a0131d',
battery_level: 0.48
}
]
*/
since | type: string
Optional | Datetime since when events were generated |
between | type: [string, string]
Optional | Lower and upper datetimes to filter by (exclusive interval) |
device_id | type: string
Optional | ID of the Device |
device_ids | type: string[]
Optional | IDs of the Devices to include |
access_code_id | type: string
Optional | ID of the Access Code |
access_code_ids | type: string[]
Optional | IDs of the Access Codes to include |
event_type | type: string
Optional | |
event_types | type: string[]
Optional |
Exactly one of
since
, between
must be provided.This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.
JSON
{
"events": [
{
"event_id": "87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2",
"event_type": "device.low_battery",
"created_at": "2022-08-24T11:23:49.459Z",
"device_id": "a83690b2-2b70-409a-9a94-426699b84c97",
"workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
"battery_level": 0.48
},
{
"event_id": "2fc8d1bc-7b4d-4960-9aa4-7e6bf5dc5848",
"event_type": "device.low_battery",
"created_at": "2022-08-24T11:23:49.335Z",
"device_id": "a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4",
"workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
"battery_level": 0.48
},
{
"event_id": "c99b497b-5ff6-4658-854a-4ee694d35355",
"event_type": "device.low_battery",
"created_at": "2022-08-24T11:23:49.150Z",
"device_id": "65803a1c-866b-45ed-94d5-496b40e4cc4d",
"workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
"battery_level": 0.48
},
{
"event_id": "e52e2527-c905-43e5-b84a-87122b64cdda",
"event_type": "device.connected",
"created_at": "2022-08-24T11:14:37.119Z",
"device_id": "a83690b2-2b70-409a-9a94-426699b84c97",
"workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d"
},
{
"event_id": "5d9dce4c-9119-4888-acd6-42044c9740b0",
"event_type": "device.connected",
"created_at": "2022-08-24T11:14:36.981Z",
"device_id": "a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4",
"workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d"
},
{
"event_id": "fea998c1-e2c7-454d-9173-8a85726aff75",
"event_type": "device.connected",
"created_at": "2022-08-24T11:14:36.796Z",
"device_id": "65803a1c-866b-45ed-94d5-496b40e4cc4d",
"workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d"
}
],
"ok": true
}
Last modified 6mo ago