Webhooks API

Webhooks operations API

List webhook deliveries

Lists webhook_deliveries for the authenticated user

SecuritybearerAuth
Request
query Parameters
filter[status][eq]
string

Return only webhook_deliveries matching the given status

Enum: "delivered" "failed"
Example: filter[status][eq]=delivered
filter[webhook][contains]
string

Return only webhook deliveries whose webhook component contains the given text

Example: filter[webhook][contains]=call.initiated
filter[attempts][contains]
string

Return only webhook_deliveries whose attempts component contains the given text

Example: filter[attempts][contains]=https://fallback.example.com/webhooks
filter[started_at][gte]
string

Return only webhook_deliveries whose delivery started later than or at given ISO 8601 datetime

Example: filter[started_at][gte]=2019-03-29T11:10:00Z
filter[started_at][lte]
string

Return only webhook_deliveries whose delivery started earlier than or at given ISO 8601 datetime

Example: filter[started_at][lte]=2019-03-29T11:10:00Z
filter[finished_at][gte]
string

Return only webhook_deliveries whose delivery finished later than or at given ISO 8601 datetime

Example: filter[finished_at][gte]=2019-03-29T11:10:00Z
filter[finished_at][lte]
string

Return only webhook_deliveries whose delivery finished earlier than or at given ISO 8601 datetime

Example: filter[finished_at][lte]=2019-03-29T11:10:00Z
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

Responses
200

A paginated array of webhook_delivery attempts

Response Schema: application/json
Array of objects (webhook_delivery)
object (PaginationMetaSimple)
401

Unauthorized

422

Unprocessable entity

get/webhook_deliveries
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "attempts": [
        • {
          • "finished_at": "2020-08-10T14:00:05.595Z",
          • "http": {},
          • "started_at": "2020-08-10T14:00:05.364Z",
          • "status": "delivered"
          },
        • {
          • "errors": [
            • {
              • "code": "75499",
              • "detail": "The server returned another HTTP 4XX error",
              • "title": "Webhook host returned HTTP 4XX"
              }
            ],
          • "finished_at": "2020-08-10T14:00:05.360Z",
          • "http": {
            • "request": {},
            • "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",
      • "status": "delivered",
      • "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
    }
}
Find webhook_delivery details by ID
Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Uniquely identifies the webhook_delivery.


 
 Example:  C9C0797E-901D-4349-A33C-C2C8F31A92C2
Responses 
200
Webhook delivery record.


Response Schema: application/json
object (webhook_delivery) 
Record of all attempts to deliver a webhook.


 
Array of objects (attempt) 
Detailed delivery attempts, ordered by most recent.


 
finished_at
string <date-time> 
ISO 8601 timestamp indicating when the last webhook response has been received.


 
id
string <uuid> 
Uniquely identifies the webhook_delivery record.


 
record_type
string
Identifies the type of the resource.


 
started_at
string <date-time> 
ISO 8601 timestamp indicating when the first request attempt was initiated.


 
status
string
Delivery status: 'delivered' when successfuly delivered or 'failed' if all attempts have failed.


 Enum: "delivered" "failed"  
user_id
string <uuid> 
Uniquely identifies the user that owns the webhook_delivery record.


 
object
Original webhook JSON data. Payload fields vary according to event type.


 
401
Unauthorized


404
WebhookDelivery not found


get/webhook_deliveries/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "attempts": [
      • {
        • "finished_at": "2020-08-10T14:00:05.595Z",
        • "http": {},
        • "started_at": "2020-08-10T14:00:05.364Z",
        • "status": "delivered"
        },
      • {
        • "errors": [
          • {
            • "code": "75499",
            • "detail": "The server returned another HTTP 4XX error",
            • "title": "Webhook host returned HTTP 4XX"
            }
          ],
        • "finished_at": "2020-08-10T14:00:05.360Z",
        • "http": {
          • "request": {},
          • "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",
    • "status": "delivered",
    • "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"
      }
    }
}