List webhook deliveries

GET

/webhook_deliveries

Webhooks

Lists webhook_deliveries for the authenticated user

Response Example

{
    "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": [
                        {
                            "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": {
                            "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",
            "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
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

filter[status][eq]

enum<string>

optional

Return only webhook_deliveries matching the given status

Allowed values:

deliveredfailed

Example:

delivered

filter[event_type]

string

optional

Return only webhook_deliveries matching the given value of event_type. Accepts multiple values separated by a ,.

Example:

call_initiated,call.initiated

filter[webhook][contains]

string

optional

Return only webhook deliveries whose webhook component contains the given text

Example:

call.initiated

filter[attempts][contains]

string

optional

Return only webhook_deliveries whose attempts component contains the given text

Example:

https://fallback.example.com/webhooks

filter[started_at][gte]

string

optional

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

Example:

2019-03-29T11:10:00Z

filter[started_at][lte]

string

optional

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

Example:

2019-03-29T11:10:00Z

filter[finished_at][gte]

string

optional

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

Example:

2019-03-29T11:10:00Z

filter[finished_at][lte]

string

optional

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

Example:

2019-03-29T11:10:00Z

page[number]

integer

optional

The page number to load

>= 1

Default:

page[size]

integer

optional

The size of the page

>= 1<= 250

Default:

Responses

🟢200OK

application/json

A paginated array of webhook_delivery attempts

Body

data

array[object (webhook_delivery) {8}]

optional

attempts

array[object (attempt) {5}]

optional

Detailed delivery attempts, ordered by most recent.

Example:

[{"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":[{"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":{"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

string <date-time>

optional

ISO 8601 timestamp indicating when the last webhook response has been received.

Example:

2020-08-10T14:00:05.595Z

string <uuid>

optional

Uniquely identifies the webhook_delivery record.

Example:

f5586561-8ff0-4291-a0ac-84fe544797bd

record_type

string

optional

Identifies the type of the resource.

Example:

webhook_delivery

started_at

string <date-time>

optional

ISO 8601 timestamp indicating when the first request attempt was initiated.

Example:

2020-08-10T14:00:00.000Z

status

enum<string>

optional

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

Allowed values:

deliveredfailed

user_id

string <uuid>

optional

Uniquely identifies the user that owns the webhook_delivery record.

Example:

0ccc7b54-4df3-4bca-a65a-3da1ecc777f0

webhook

object

optional

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

Example:

{"event_type":"call_initiated","id":"C9C0797E-901D-4349-A33C-C2C8F31A92C2","occurred_at":"2020-08-10T13:02:01.000Z","payload":{"useful":"information"},"record_type":"event"}