Live inbox events

GET 
/inbox/stream

A Server-Sent Events stream of what happens in the inbox: new message, message status, conversation updated, someone typing. Events say what changed, without the content — fetch the conversation or the messages afterwards.

The stream starts with event: ready and sends a : ping comment every 25 seconds. There is no replay: each event's id is a per-connection counter, and Last-Event-ID recovers nothing. On every (re)connection, read again what matters. The browser's EventSource does not send the Authorization header — use a client that does. At most 5 open streams per API key.

Responses

200

text/event-stream stream. Events: message.created, message.updated, conversation.updated and typing, each with conversationId and phoneNumberId in data.

401

Missing, malformed, unknown or revoked token (authentication), or a suspended account (tenant_inactive).

402

No entitlement (payment_required). The body carries the reason in reason and the way out in action: what to do (kind) and the dashboard page where it is done (url).

429

Too many streams open for this credential (too_many_streams).