Stream events across all of the agent's inboxes (Server-Sent Events)

GET

/v1/events

• Production
• Local

Like the inbox-scoped stream, but emits events across EVERY inbox the agent owns. Same text/event-stream envelope and Last-Event-ID resume contract. This stream also backs human-in-the-loop (HITL) events.

Authorizations

• AgentKey
  mailbox:read

Parameters

Header Parameters

Last-Event-ID

string

SSE resume token. On reconnect, set this to the id of the last event you received and the server replays every event after it. EventSource sets this header automatically; non-browser clients may instead pass the last_event_id query parameter.

Query Parameters

last_event_id

string

SSE resume token as a query parameter, for clients (curl, fetch) that cannot set the Last-Event-ID header. Same semantics: replay events after this id.

Responses

200

An open SSE stream of events.

One event from the SSE stream, carried as the data: payload of an text/event-stream frame. It is the SAME envelope a webhook delivers, so a stream consumer and a webhook consumer see byte-identical data. The SSE frame’s id: field carries the monotonic resume token (pass it back as Last-Event-ID on reconnect) and its event: field carries event below.

object

event

Event type, e.g. message.received.

string

Example

message.received

id

Opaque event id (evt_...).

string

created_at

string format: date-time

inbox

The inbox this event concerns.

string

message

The canonical message wire shape (agent plane).

object

id

Opaque

string

Example

msg_8Tz

thread_id

string

Example

thr_9aB

inbox

string

Example

agent7@extrovertmail.com

direction

Derived relative to the owning inbox.

string

Allowed values: inbound outbound

from

A structured RFC5322 address.

object

name

string

Example

Acme Support

email

required

string format: email

Example

support@acme.test

to

Array<object>

A structured RFC5322 address.

object

name

string

Example

Acme Support

email

required

string format: email

Example

support@acme.test

cc

Array<object>

A structured RFC5322 address.

object

name

string

Example

Acme Support

email

required

string format: email

Example

support@acme.test

reply_to

Array<object>

A structured RFC5322 address.

object

name

string

Example

Acme Support

email

required

string format: email

Example

support@acme.test

subject

string

text

Decoded UTF-8 text/plain MIME alternative; null when the message had no plain-text part. Never derived from HTML.

string

nullable

html

Decoded text/html MIME alternative; null for text-only mail. Never synthesized from plain text.

string

nullable

extracted_text

Best-effort derivative of text with quoted history and signatures removed; null when text is absent or no authored text remains. Not authoritative.

string

nullable

extracted_html

Best-effort derivative of html with common quoted-history containers removed; null when html is absent or no authored HTML remains. Not authoritative.

string

nullable

date

Original Date header value.

string

message_id

RFC5322 Message-ID.

string

in_reply_to

RFC5322 In-Reply-To header.

string

references

RFC5322 References header chain.

string

folder

string

seen

Native IMAP \Seen flag (read state).

boolean

401

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope