Subscribe to inbox notifications over SSE
Opens a Server-Sent Events stream that emits one frame per batch of newly-available messages on the inbox. The connection stays open until the JWT expires, at which point the server closes it.
Two kinds of frames are emitted:
- Data frames (
data: {...}\n\n) signal availability only, they do not include message content. Consumers should call the lease endpoint to retrieve messages. The JSON payload is described by the response schema below. Each data frame includes a cursor that clients can provide when reconnecting. Catch-up delivery is at least once, so messages within the lookback window may be reported again. - Heartbeat frames (
: keep-alive\n\n) are SSE comment lines sent when no notification has arrived within the heartbeat interval. They are ignored by EventSource clients and exist only to keep intermediaries from closing the connection as idle.
Authorizations
OAuth 2.0 authentication.
Path Parameters
The unique identifier of the inbox to subscribe to.
Query Parameters
An opaque cursor from the most recently received data frame. When provided, the stream immediately reports messages that may have arrived since that cursor. Cursors older than the message retention period are rejected.
Response
SSE stream opened. The response body is an open-ended sequence of text/event-stream frames.
JSON payload carried by each data: frame. Heartbeat frames carry no payload.