How the stream works
A client opens a long-lived connection to the workspace’s events route. It is a standard server-sent events stream.- The server first sends a
readyevent with the currentsequence. - It then sends events as they happen. Each has an
id, which is its sequence number, and an event name, which is its type. - If the connection drops, the client reconnects and sends the last
idit saw, in theLast-Event-IDheader or as?after=. It receives only what it missed.
Event types
Every event carries its
sequence, its type, the workspaceId, who did it (actor) and when (occurredAt), plus the ids that say what it is about, such as the recordId or the taskId.
A caller receives only the events it may see. A notification event goes to its recipient alone.
Related
- SDK events and notifications: subscribe in one line.
- Workflows and tasks: act on changes without code.