Every endpoint on this page requires either a Clerk-issued JWT (
Authorization: Bearer <token>) or
an organization API key (x-api-key: pk_…). Anonymous calls return 401 Unauthorized. See
Authentication for the full setup.GET /v1/chat/events/stream. Use it to update dashboards, push notifications, or trigger downstream automation.
Connect
Event types
| Event | Triggered when |
|---|---|
session.started | A new chat or voice session is created |
session.updated | Session state, agent assignment, or analytics change |
session.ended | Session is closed (manually, expired, or call ended) |
message.added | A new message is added to a session |
usage.updated | Usage metrics for the org change |
subscription.updated | Plan change, cancel, or resume |
knowledge_store.updated | A knowledge store document finishes processing |
heartbeat | Sent every 30s; use to detect a dead connection |
Reconnecting
The browser’sEventSource reconnects automatically with the Last-Event-ID header. Keep your client side-effect-free with respect to event order — at least one delivery is guaranteed, ordering is not.