messages

Server-Sent Events push of new messages

SSE alternative to long-poll wait: emits a message event per newly-ingested matching message, a periodic : heartbeat comment, and a final bye event before closing (clients reconnect with a fresh since cursor via the advertised retry:). Consumes the same per-account and global wait-capacity slots as messages/wait (routed through a smaller reserved sub-pool for Free/agent-plan accounts so free traffic can never starve paid waits).

get/inboxes/{id}/stream

Request

  • Base URL: https://dash.mailsocket.app/api/v1
  • URL: https://dash.mailsocket.app/api/v1/inboxes/{id}/stream
  • Auth: HTTP bearer

Path parameters

idstring required

The inbox public ID (e.g. inbox_...).

Query parameters

require'otp' | 'link' | 'any'

What counts as a match. Any other value -> 422 validation_error.

min_confidencenumber
sincestring

Response

text/event-stream of message/heartbeat/bye events.

Changes

No recorded changes to this operation across all 1 revision of this API.