Skip to main content
GET
Stream mailbox events

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

Last-Event-ID
string

Query Parameters

event_types
string

Comma-separated list: message.received, message.received.spam.

last_event_id
string
ping
integer
Required range: 10 <= x <= 300
close_after
integer
Required range: 30 <= x <= 3600
mailbox_id
string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Response

Server-sent event stream. Event data uses the MailboxRealtimeEvent shape.

event_type
enum<string>
required
Available options:
message.received,
message.received.spam,
sync_required
is_spam
boolean | null
required
mailbox_id
string
required
message
object
required
message_id
string | null
required
message_id_kind
enum<string> | null
required
Available options:
provider,
rfc5322
occurred_at
string
required
recipients
string[]
required
sender
string | null
required
team_public_id
string
required