Show a delivery

GET

/v1/webhooks/{webhook_id}/deliveries/{id}

const url = 'http://api.disclosebot.localdev:3000/v1/webhooks/example/deliveries/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://api.disclosebot.localdev:3000/v1/webhooks/example/deliveries/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Path Parameters

webhook_id

required

string

required

string

Responses

200

Successful

application/vnd.api+json

object

data

required

object

required

Also the webhook-id header of every attempt, and the consumer’s idempotency key.

string format: uuid

type

required

string

Allowed values: webhook_delivery

attributes

required

object

status

required

string

Allowed values: pending delivered failed

trigger_event_type

required

string

request_id

Present when a channel asked for the delivery, null for an event subscription.

string format: uuid

nullable

attempts

required

integer

attempt_log

required

One entry per attempt, oldest first, with what the endpoint said.

Array<object>

object

integer

string format: date-time

rate_limited

boolean

response

object

code

integer

nullable

body_excerpt

string

nullable

error

string

nullable

payload

required

What was sent, built when the delivery was created and never rebuilt.

object

delivered_at

string format: date-time

nullable

created_at

required

string format: date-time

updated_at

required

string format: date-time

relationships

object

webhook

object

data

object

required

string format: uuid

type

required

string

Allowed values: webhook

Example

{
  "data": {
    "type": "webhook_delivery",
    "attributes": {
      "status": "pending"
    },
    "relationships": {
      "webhook": {
        "data": {
          "type": "webhook"
        }
      }
    }
  }
}

404

A delivery of another webhook