Retrieves the details of an event. Supply the unique identifier of the event, which can be found in a webhook's payload.
SecurityAuthToken
Request
query Parameters
occurred_at
string <date-time>
Filter events on the occurred_at timestamp. Must be in ISO-8601 format.
occurred_at.gt
string <date-time>
Filter events gt(>) occurred_at timestamp. Must be in ISO-8601 format.
occurred_at.gte
string <date-time>
Filter events gte(=>) occurred_at timestamp. Must be in ISO-8601 format.
occurred_at.lt
string <date-time>
Filter events lt(<) occurred_at timestamp. Must be in ISO-8601 format.
occurred_at.lte
string <date-time>
Filter events lte(<=) occurred_at timestamp. Must be in ISO-8601 format.
event_name
string
Filter events on the name of the event or type (e.g. shipment.created).
event_name.in
Array of strings non-empty
A comma-separated list of up to 20 strings containing specific event names. The list includes only events with a matching event property. You may pass either event_name or event_name.in, but not both.
delivery_success
boolean
Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint are returned.
starting_after
string
The ID of the previous event to start the page after.
ending_before
string
The ID of the first event of the next page. This current page ends with the event ID immediately preceding the one given in this parameter.