Retrieve an event stream

GET/event-streams/{event_stream_id}

Returns the event stream's status, filters, delivery cursor, and connection state.

Revoked and expired event streams remain retrievable.

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

event_stream_id*string

Public ID of the event stream, prefixed with str_.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

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": {      "event_types": [        "string"      ],      "resource_types": [        "string"      ]    },    "id": "string",    "last_seen_at": "2019-08-24T14:15:22Z",    "object": "event_stream",    "status": "active"  }}