Skip to main content
The GET /realtime/events endpoint exposes a workspace event stream using server-sent events (SSE). Your key needs realtime:read.

Open a stream

Events use SSE id, event, and data fields. Parse complete events before processing them. A new connection without a cursor listens for live events.

Reconnect and resume

Save the last successfully processed event ID. On reconnection, send it as Last-Event-ID, or use the endpoint’s cursor query parameter.
Expect heartbeats and periodic disconnections. Reconnect with backoff, deduplicate event IDs, and handle stream errors. Consult the endpoint reference for cursor behavior and response details.

Connect through your server

Do not put a workspace API key into browser JavaScript or a URL. Keep this stream on your server and forward only the events an authenticated application user is authorized to see. For background integrations that do not need a persistent connection, use webhooks.