Skip to main content
GET
GET /api/events/stream
Opens a persistent SSE connection that streams real-time updates for a specific connection. The dashboard uses this endpoint to provide live updates without polling.

Authentication

Session cookie (dashboard).
The SSE endpoint authenticates via session cookies only — it cannot be consumed by external scripts or tools that don’t share the browser session. API key authentication for all endpoints, including SSE, is planned for V1.

Query parameters

Event format

Events follow the SSE specification:

Event types

Connection handling

  • The SSE connection stays open indefinitely until the client disconnects.
  • A heartbeat event is sent every 15 seconds to keep the connection alive through proxies and load balancers.
  • If the connection drops, reconnect with the same URL. The browser’s EventSource API handles reconnection automatically.

Example (JavaScript)