WoyraDocs
Get an API key

Live message events

GET/v1/console/stream

Console · Requires an API key

A server-sent event stream of message status changes for the calling account, so a console page can update itself rather than polling.

Console sessions only. A stream is the wrong shape for an API key, which should ask for what it needs and hang up; a key that wants delivery news should register a webhook endpoint, which is durable, signed and retried, where this is neither.

The stream is a **hint that something changed, never the only place a change can be learned**. Events are dropped for a client that stops reading, and are lost entirely while a connection is down, so a consumer must reconcile against the list endpoints on reconnect rather than treating the stream as a ledger.

Events are ready once on connection, then message per change:

`` event: message data: {"object":"message.updated","id":"msg_...","channel":"email", "status":"delivered","carrier":"smtp-primary"} ``

A comment line is written every 25 seconds to keep intermediaries from closing an idle connection.

Example

curl https://api.woyra.io/v1/console/stream \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 The stream. Stays open until the client or the server closes it.

Errors

StatusCodes
401authentication_required, invalid_api_key

Also in Console