/events/stream
Stream your organization's events
Needs the
events:read
scope.
Server-Sent Events of every hub's events. Each message's id is the
event's cursor in your organization's log and its event the event
type. Starts after Last-Event-ID, or with the next new event
without it; then the stream opens with an id: line alone, the
cursor it starts from. A : keepalive comment arrives every 30
seconds. The server ends the stream after 15 minutes; reconnect with
Last-Event-ID. Takes the filters of GET /v1/events.
Between events, the stream sends signals (Signal): hub.created,
hub.updated, sim.updated, setup_code.created,
setup_code.updated and setup_code.deleted. A signal has no id:
it isn't kept, so Last-Event-ID doesn't replay it. It names what
changed; read it again. At most one of a type a second for a hub.
type, hub_id and site_id filter signals too; device_id
leaves them out, and category=connectivity keeps hub.updated and
sim.updated.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
Last-Event-ID
|
header |
string
|
|
type
|
query |
string
|
Only events whose type starts with one of these comma-separated prefixes: device., hub.online,hub.offline. At most 20.
|
category
|
query |
"connectivity"
|
connectivity: only events about the hub's connection: hub.online, hub.offline, hub.unstable, hub.stable, hub.network_changed, hub.wifi_failover, hub.condition, and the hub alarms about connectivity.
|
hub_id
|
query |
string
|
|
site_id
|
query |
string
|
Only events from the site's hubs. |
device_id
|
query |
integer
|
Responses
200
An event stream.
id: 8812
event: channel.observed
data: {"id":"evt_104311","cursor":"8812","type":"channel.observed","hub_id":"1key-xfy2-nmf4-5xwp","device_id":7,"time":"2026-10-03T14:03:11.143000Z","clock_trusted":true,"data":{"key":"lock","endpoint":0,"value":false}}
event: hub.updated
data: {"type":"hub.updated","hub_id":"1key-xfy2-nmf4-5xwp","site_id":"0b7c5e0e-6a43-4f7e-9d0a-2f3c1b9e8d21","time":"2026-10-03T14:03:12.020000Z","data":{"changed":["connection","status"]}}
Errors
invalid_request
The request is malformed or a field is invalid.
unauthenticated
Missing, malformed, revoked or unknown API key.
insufficient_scope
The key lacks the scope this operation needs.