Skip to main content
GET
Real-time event stream (SSE)

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Headers

Last-Event-ID
string

Reconnection cursor. Alternative to the Last-Event-ID header for fetch clients.

Query Parameters

last_event_id
string

Reconnection cursor. Alternative to the Last-Event-ID header for fetch clients.

types
string

Comma-separated event types to filter. An unknown type returns 400 invalid_event_type.

snapshot
boolean

When true, the first event is snapshot with the absolute current state (balances and, for org-admins, operational health) before the live deltas.

account_id
string<uuid>

Org-admin only: narrows the org-wide channel to a single account.

Response

Event stream opened. The body stays open and is written incrementally.

The response is of type string.

Last modified on August 22, 2026