Events
Stream Events
Changed onStream events as Server-Sent Events.
get/events/stream
Request
- Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
- URL: /events/stream
- Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)
Query parameters
sincestring date-time nullable
Stream events created after this time (RFC 3339); defaults to now, and a future time is treated as now.
Example:2026-01-01T00:00:00Z
event_typestring[] nullable
Only return events of one of these types; repeat the parameter for several.
[ "import.completed" ]
severityEvent Severity[] nullable
Only return events with one of these severities; repeat the parameter for several.
[ "warning", "error" ]
requires_actionboolean nullable
Only return events whose requires_action flag matches.
Example:true
trace_idstring nullable
Only return events with this trace ID.
Example:4bf92f3577b34da6a3ce929d0e0e4736
actor_idstring nullable
Only return events caused by this actor.
Example:agnt_6968b3984d1c238dbe7e2e29
actor_typestring nullable
Only return events caused by this kind of actor, e.g. user or agent.
Example:agent
Headers
Last-Event-IDstring nullable
ID of the last event received (evt_ plus 24 hex characters), to resume a stream after it; ignored if the event is not visible to the caller.
Example:evt_6968b398b04f002b6dbff4d1
Response
Successful Response
unknown required
Changes
- info
the endpoint scheme security
OAuth2was added to the API
- info
- info
endpoint added
- info