Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Events API

A read-only feed of every notable event in the platform — message sent, message delivered, agent run, flow step, contact updated, conversation opened, webhook fired, etc. Two access patterns:
  • Polled — GET /v1/events returns paginated history.
  • Live — GET /v1/events/stream opens an SSE connection that delivers events in real time.
Base path: /v1/events Authentication: API key (X-API-Key) or session JWT.
MethodPathPurpose
GET/v1/events/List events (paginated)
GET/v1/events/{id}Get a single event
GET/v1/events/streamSubscribe via Server-Sent Events

​
Live stream — SSE

curl -N "https://orbit-api.devotel.io/api/v1/events/stream?token=dv_live_sk_your_key_here"
Events arrive as data: lines (one JSON object per line). Reconnect on error with the Last-Event-ID header set so you don’t lose events. The ?token= query parameter is promoted to X-API-Key server-side so browsers (which can’t set arbitrary headers on EventSource) can authenticate. The token is not logged in access logs for this endpoint.

​
See also

  • Webhooks — for delivered, durable, retry-handled push of the same events