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

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

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

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.