Skip to main content

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.

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

    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
  • ]

  • ]

401: Unauthorized

404: WebhookDelivery not found

Loading...