GET
/v1/eventsList events
Lists events created within the last 30 days. Use created, type, or types to filter results and starting_after or ending_before to traverse the list; do not provide type and types together.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
createdobjectoptional
Filter by creation time using a Unix timestamp or a range with `gt`, `gte`, `lt`, or `lte`.
delivery_successbooleanoptional
Filter by whether all webhook deliveries for an event succeeded.
ending_beforestringoptional
Cursor identifying the event before which to return results.
expandarray<string>optional
Fields to expand in the response; each value can contain at most 5000 characters.
limitintegeroptional
Maximum number of events to return, from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
Cursor identifying the event after which to return results.
typestringoptional
Filter by one event name or a wildcard event group. Do not use with `types`.
typesarray<string>optional
Filter by up to 20 specific event names. Do not use with `type`.
200Returns a list object containing event objects, a pagination indicator, the list object type, and the collection URL.
dataarray<Event>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultReturned when the API cannot process the list request; the response contains an error object.
errorobjectrequired
Error handling
limit must be between 1 and 100. types can contain at most 20 event names, and you must choose either type or types; starting_after and ending_before identify pagination positions.