Webhooks
List webhook deliveries
Lists webhook_deliveries for the authenticated user
get/webhook_deliveries
Query parameters
Consolidated page parameter (deepObject style). Originally: page[number], page[size]
Consolidated filter parameter (deepObject style). Originally: filter[status][eq], filter[event_type], filter[webhook][contains], filter[attempts][contains], filter[started_at][gte], filter[started_at][lte], filter[finished_at][gte], filter[finished_at][lte]
{
"attempts": {
"contains": "https://fallback.example.com/webhooks"
},
"event_type": "call_initiated,call.initiated",
"finished_at": {
"gte": "2019-03-29T11:10:00Z",
"lte": "2019-03-29T11:10:00Z"
},
"started_at": {
"gte": "2019-03-29T11:10:00Z",
"lte": "2019-03-29T11:10:00Z"
},
"status": {
"eq": "delivered"
},
"webhook": {
"contains": "call.initiated"
}
}Response
A paginated array of webhook_delivery attempts
Example response
{
"data": [
{
"attempts": [
{
"finished_at": "2020-08-10T14:00:05.595Z",
"http": {
"request": {
"headers": [
[
"Accept",
"*/*"
]
],
"url": "https://fallback.example.com/webhooks"
},
"response": {
"body": "All good.",
"headers": [
[
"Content-Type",
"text/html"
]
],
"status": 200
}
},
"started_at": "2020-08-10T14:00:05.364Z",
"status": "delivered"
},
{
"errors": [
75499
],
"finished_at": "2020-08-10T14:00:05.360Z",
"http": {
"request": {
"headers": [
[
"Accept",
"*/*"
]
],
"url": "https://typo.example.com/webhooks"
},
"response": {
"body": "Oops. Not found.",
"headers": [
[
"Content-Type",
"text/html"
],
[
"Pragma",
"no-cache"
]
],
"status": 404
}
},
"started_at": "2020-08-10T14:00:05.004Z",
"status": "failed"
}
],
"finished_at": "2020-08-10T14:00:05.595Z",
"id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"record_type": "webhook_delivery",
"started_at": "2020-08-10T14:00:00.000Z",
"user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"webhook": {
"event_type": "call_initiated",
"id": "C9C0797E-901D-4349-A33C-C2C8F31A92C2",
"occurred_at": "2020-08-10T13:02:01.000Z",
"payload": {
"useful": "information"
},
"record_type": "event"
}
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}