Retrieve an event stream
/event-streams/{event_stream_id}Returns the event stream's status, filters, delivery cursor, and connection state.
Revoked and expired event streams remain retrievable.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/event-streams/string"{ "data": { "connection": { "connected": true, "since": "2019-08-24T14:15:22Z" }, "created_at": "2019-08-24T14:15:22Z", "cursor": { "advanced_at": "2019-08-24T14:15:22Z", "last_event_id": "string" }, "expires_at": "2019-08-24T14:15:22Z", "filters": null, "id": "string", "last_seen_at": "2019-08-24T14:15:22Z", "object": "event_stream", "status": "active" }}Create an event stream POST
Creates an event stream that delivers the account's public events over Server-Sent Events (SSE), with the same payloads and ordering as the events collection. Optional filters restrict the stream to specific event types and resource types. Requires an `Idempotency-Key` header. The credential must also have the `events.read` permission; otherwise the request fails with `permission_denied`. The number of active event streams is limited per credential and per account. Creating a stream beyond these limits returns `too_many_streams`.
Revoke an event stream DELETE
Revokes the event stream and closes any open connection to it shortly afterward. The stream is not removed: it remains available through the retrieve and list operations with the `revoked` status.