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.

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