Webhooks

List Webhook Deliveries

Changed on

Lists delivery attempts for a webhook, newest first.

Use success, event_id, start, and end to narrow the results. Results are ordered by attempt time, newest first. Pass the returned next_page_token as page_token to fetch the next page. An empty token means there are no more results. Response bodies contain content returned by your webhook endpoint. Attempts are listed only while their event is retained.

get/api/webhooks/{id}/deliveries

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Webhook ID

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Query parameters

successboolean nullable

Filter by delivery result.

event_idstring uuid nullable

Return only attempts to deliver this event.

Example:248df4b7-aa70-47b8-a036-33ac447e668d
startstring date-time nullable

Include attempts at or after this time.

endstring date-time nullable

Include attempts before this time.

page_tokenstring

Token from the previous page

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "event_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
    }
  ],
  "pagination": {
    "next_page_token": "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K=="
  }
}

Changes