Skip to navigation
API ReferenceEvent Subscriptions

List events

Returns immutable events for the event types your workspace subscribes to. Event types you have no subscription for are not listed.

Within those types, delivery state does not filter the list. An event whose subscription was paused at the time, or whose workflow filter did not match, has no delivery and is still returned with deliverySummary.total of 0 - that is how you see what your webhook setup missed. With subscriptionId, only events delivered to that subscription are returned and deliverySummary is scoped to it.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Query parameters

pageintegerOptional>=0Defaults to 0

Zero-based page index. Defaults to 0.

sizeintegerOptional1-100Defaults to 50
Page size between 1 and 100. Defaults to 50.
eventTypeenumOptional
Filter by one event type. An event type without a subscription returns no events.
Allowed values:
subscriptionIdstringOptional
Return only events that have at least one delivery to this subscription. Manual resends do not duplicate an event in the list.
fromdatetimeOptional

Return events created at or after this UTC ISO-8601 timestamp (inclusive).

todatetimeOptional

Return events created at or before this UTC ISO-8601 timestamp (inclusive).

sortenumOptional

Sort by createdAt in asc or desc order. Defaults to desc.

Allowed values:

Response headers

Cache-ControlstringOptional
Prevents storage of webhook configuration, payload, and diagnostic responses.

Response

One page of immutable events with aggregate delivery counts.
datalist of objects
Items on the requested page.
pageInfoobject
Paging details for this result set.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
405
Method Not Allowed Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error