List webhook deliveries

GET 
/webhook_deliveries

Lists webhook_deliveries for the authenticated user

Request

Query Parameters

filter[status][eq] string

Possible values: [delivered, failed]

Return only webhook_deliveries matching the given status

filter[event_type] string

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

filter[webhook][contains] string

Return only webhook deliveries whose webhook component contains the given text

filter[attempts][contains] string

Return only webhook_deliveries whose attempts component contains the given text

filter[started_at][gte] string

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

filter[started_at][lte] string

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

filter[finished_at][gte] string

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

filter[finished_at][lte] string

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

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

Responses

200: A paginated array of webhook_delivery attempts

application/json

Schema

Schema

data

webhook_delivery[]

Array [

id uuid

Uniquely identifies the webhook_delivery record.

user_id uuid

Uniquely identifies the user that owns the webhook_delivery record.

record_type string

Identifies the type of the resource.

status string

Possible values: [delivered, failed]

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

webhook

object

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

record_type string

Possible values: [event]

Identifies the type of the resource.

event_type string

Possible values: [webhook.command]

The type of event being delivered.

id uuid

Identifies the type of resource.

occurred_at date-time

ISO 8601 datetime of when the event occurred.

payload

object

started_at date-time

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

finished_at date-time

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

attempts

attempt[]

Detailed delivery attempts, ordered by most recent.

Array [

status string

Possible values: [delivered, failed]

started_at date-time

ISO 8601 timestamp indicating when the attempt was initiated.

finished_at date-time

ISO 8601 timestamp indicating when the attempt has finished.

http

http

HTTP request and response information.

request

Request details.

url string

headers string[]

List of headers, limited to 10kB.

response

nullable

Response details, optional.

status integer

headers string[]

List of headers, limited to 10kB.

body string

Raw response body, limited to 10kB.

errors

error[]

Webhook delivery errors.

Array [

code int

title string

detail string

]

]

]

meta

object

page_number integer

page_size integer

total_pages integer

total_results integer

Example (from schema)

{
  "data": [
    {
      "id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
      "user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      "record_type": "webhook_delivery",
      "status": "delivered",
      "webhook": {
        "record_type": "event",
        "id": "C9C0797E-901D-4349-A33C-C2C8F31A92C2",
        "event_type": "call_initiated",
        "occurred_at": "2020-08-10T13:02:01.000Z",
        "payload": {
          "useful": "information"
        }
      },
      "started_at": "2020-08-10T14:00:00.000Z",
      "finished_at": "2020-08-10T14:00:05.595Z",
      "attempts": [
        {
          "status": "delivered",
          "started_at": "2020-08-10T14:00:05.364Z",
          "finished_at": "2020-08-10T14:00:05.595Z",
          "http": {
            "request": {
              "url": "https://fallback.example.com/webhooks",
              "headers": [
                "Accept: */*"
              ]
            },
            "response": {
              "status": 200,
              "headers": [
                "Content-Type: text/html"
              ],
              "body": "All good."
            }
          }
        },
        {
          "status": "failed",
          "started_at": "2020-08-10T14:00:05.004Z",
          "finished_at": "2020-08-10T14:00:05.360Z",
          "http": {
            "request": {
              "url": "https://typo.example.com/webhooks",
              "headers": [
                "Accept: */*"
              ]
            },
            "response": {
              "status": 404,
              "headers": [
                "Content-Type: text/html",
                "Pragma: no-cache"
              ],
              "body": "Oops. Not found."
            }
          },
          "errors": [
            {
              "code": "75499",
              "title": "Webhook host returned HTTP 4XX",
              "detail": "The server returned another HTTP 4XX error"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

401: Unauthorized

422: Unprocessable entity

Loading...