Webhooks

List an endpoint's deliveries

GET
/v1/webhook-endpoints/{id}/deliveries

Each event sent to this endpoint, from newest to oldest, with each attempt.

Authorization

AuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.

In: header

Path Parameters

id*string
Formatuuid

Query Parameters

limit?integer

How many per page, from 1 to 100.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor or prev_cursor of a previous response. Without a cursor, the first page.

Lengthlength <= 200
status?string

Value in

  • "pending"
  • "succeeded"
  • "failed"
event_type?string

Only those of this event type: invoice.authorized.

Lengthlength <= 100
document_id?string

Only those of events about this document.

Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "webhook_delivery",      "endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c",      "event": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "string",        "data": {          "property1": null,          "property2": null        },        "created_at": "2019-08-24T14:15:22Z"      },      "status": "pending",      "attempts": [        {          "at": "2019-08-24T14:15:22Z",          "status_code": 0,          "error": "string",          "duration_ms": 0        }      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "prev_cursor": "string"}