Sign in

v1

latestOpenAPI 3.0.02026-07-2447166133.5 KB
Webhooks

List events for an endpoint

This operation retrieves information about events that have been attempted to be published to a webhook destination endpoint. Events are queryable for a period of 30 days after creation and are returned in sets of 20 at a time. Use the pagination token to retrieve more events.

get/webhooks/endpoints/{endpointId}/events

Path parameters

endpointIdstring required

The id of a webhook destination endpoint

Example:wde_01HWDG5ADNBGJ3XXXXXFP8P1GH

The id of the webhook destination endpoint.

Query parameters

startTimestring date-time
Example:2020-04-01T00:00:00Z

The start time of the events to retrieve.

endTimestring date-time
Example:2020-04-01T00:00:00Z

The end time of the events to retrieve.

paginationTokenstring

Token given in a previous response to allow requesting the next page

Example:abcdefghijklmnop

Response

ok

hasMoreboolean required
paginationTokenstring

Token given in a previous response to allow requesting the next page

Example response

{
  "events": [
    {
      "delivery": {
        "deliveryTime": "2020-04-01T00:00:00Z",
        "nextAttemptTime": "2020-04-01T00:00:00Z"
      },
      "eventTime": "2020-04-01T00:00:00Z",
      "id": "wev_01HWDG5ADNBGJ3XXXXXFP8P1GH"
    }
  ],
  "paginationToken": "abcdefghijklmnop"
}