Documentation menu

API reference

1 operation in events. Raw spec: openapi.json.

GET/api/v1/events/stream

GET /api/events/stream — live contract-event + presence frames.

Response is `text/event-stream`: `data:` frames are the StreamFrame JSON documented above, each carrying its event uuid as the SSE `id:` field; comment heartbeats every 15s keep intermediaries from closing an idle connection. A per-user connection cap (8) guards fan-out memory; over the cap the request is a typed 429. A `Last-Event-ID` header triggers a bounded outbox replay of the events missed while disconnected (see the resume section above); past the replay buffer the client falls back to full snapshot rehydration.

Parameters

NameInTypeRequiredDescription
ticketquery—NoOptional per-entity scope: only frames for this ticket (its events AND its presence) are delivered. Omit for the org-wide stream.

Responses

StatusDescription
200text/event-stream of StreamFrame JSON data lines with id: fields and comment heartbeats; honors Last-Event-ID for bounded resume replay
401missing or invalid bearer token
429per-user connection cap reached; reconnect later

Security: bearer