Skip to main content
GET
Subscribe to the real-time platform event stream (SSE)

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Query Parameters

types
string

Comma-separated allowlist of event types to deliver (e.g. message.delivered,message.failed). Applied to both the Last-Event-ID replay pass and the live tail. Omit to receive all event types for the tenant.

lastEventId
string

Resume cursor — the id of the last event the client received. Replays buffered events newer than this id before live streaming.

Response

200 - text/event-stream

text/event-stream payload. Each frame is id: <streamId>\nevent: <type>\ndata: <json>\n\n; reconnect with the final id as the Last-Event-ID to resume without gaps.

text/event-stream payload. Each frame is id: <streamId>\nevent: <type>\ndata: <json>\n\n; reconnect with the final id as the Last-Event-ID to resume without gaps.