Realtime events

Server-Sent Events, CTI events, heartbeats, and org filtering.

SSE stream

The realtime API should be documented as the way browser clients and integrations observe live CRM events. Event payloads can represent record changes, notifications, CTI events, and heartbeats.

javascript

Connect to the event stream

const source = new EventSource('/api/v1/events');
source.onmessage = (event) => {
  const payload = JSON.parse(event.data);
  console.log(payload.type, payload);
};