Events

List an event destination's events

Returns a cursor-paginated list of the events fanned out to this destination, newest first, with the destination's per-event delivery outcome. Filter by delivery_status and fire time (created[gte] / created[lte]), and expand attempts to include each delivery try. Events remain inspectable after the destination is deleted.

get/event-destinations/{id}/events

Path parameters

idstring required
Example:whe_a1b2c3d4e5f6

Query parameters

limitinteger

Page size, 1 to 100.

Example:20

Page size, 1 to 100.

starting_afterstring

Return the page after this resource id (newest first).

Return the page after this resource id (newest first).

delivery_status'pending' | 'delivered' | 'failed'

Filter to a single per-destination delivery status.

Filter to a single per-destination delivery status.

created[gte]integer nullable

Only events fired at or after this epoch ms.

Only events fired at or after this epoch ms.

created[lte]integer nullable

Only events fired at or before this epoch ms.

Only events fired at or before this epoch ms.

expand[]string[]

Repeatable. Expand attempts to include each delivery try.

Repeatable. Expand attempts to include each delivery try.

Response

A page of events for the destination.

has_moreboolean required

True when another page follows the returned one.

next_cursorstring nullable required

Pass as starting_after to fetch the next page; null when has_more is false.

Example response

{
  "data": [
    {
      "id": "evt_7Ye2kQp91LmXw4Za",
      "attempts": [
        {
          "id": "atmpt_Zw8n1Rq4Yv5c",
          "event_id": "evt_7Ye2kQp91LmXw4Za"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.