Skip to main content
GET
Subscribe to inbox notifications over SSE

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication.

Path Parameters

inbox_id
string<uuid>
required

The unique identifier of the inbox to subscribe to.

Query Parameters

cursor
string

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.

inbox_id
string<uuid>
required

The unique identifier of the inbox that has new messages.

count
integer
required

The number of notifications coalesced into this frame.

Required range: x >= 1
cursor
string
required

An opaque cursor that clients should store and provide when reconnecting.

Last modified on August 20, 2026