Find webhook_delivery details by ID

GET 
/webhook_deliveries/:id

Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.

Request

Path Parameters

id uuidrequired

Uniquely identifies the webhook_delivery.

Responses

200: Webhook delivery record.

application/json

• Schema
• Example (from schema)

Schema

data

webhook_delivery

Record of all attempts to deliver a webhook.

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

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

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.

Request details.

response

nullable

Response details, optional.

status integer

headers string[]

List of headers, limited to 10kB.

body string

Raw response body, limited to 10kB.

Response details, optional.

HTTP request and response information.

errors

error[]

Webhook delivery errors.

Array [

code int

title string

detail string

]

Webhook delivery errors.

]

Detailed delivery attempts, ordered by most recent.

Record of all attempts to deliver a webhook.

{
  "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"
          }
        ]
      }
    ]
  }
}

401: Unauthorized

404: WebhookDelivery not found

Loading...