List deliveries

Page through your webhook deliveries, newest first, filtered by partner, endpoint, event or status.

GET{BASE_URL}/webhooks/deliveries

Returns your webhook deliveries — each one event sent to one endpoint, with its attempts and your endpoint's last answer — newest first, one page at a time. Requires a provider key; the partner header is ignored.

Query parameters

partnerIdstringoptional: Only deliveries of this partner's events.
endpointIdstringoptional: Only deliveries to this endpoint. An ID that is not one of your endpoints answers 404.
eventstringoptional: Only this event type, such as booking.created.
statusstringoptional: PENDING, SUCCEEDED or FAILED, in any case.
limitintegeroptional: Deliveries per page, at least 1. Default 25; values above 100 are treated as 100.
offsetintegeroptional: Deliveries to skip, at least 0. Default 0.

`status`	Means
`PENDING`	Not delivered yet; the next attempt is at `nextAttemptAt`.
`SUCCEEDED`	Your endpoint answered `2xx`.
`FAILED`	Every attempt failed, or the failure was not retryable. Replay it when your endpoint is fixed.

Response

data.itemsobject[]required: The page of deliveries.
data.totalintegerrequired: How many deliveries match, across all pages.
data.limitintegerrequired: The page size used.
data.offsetintegerrequired: The offset used.

Status codes#

Status	Code	Meaning
`200`	—	Success.
`400`	—	`status`, `event`, `limit` or `offset` is invalid.
`403`	`provider_key_required`	A partner key made the call.
`404`	`webhook_endpoint_not_found`	`endpointId` is not one of your endpoints.

curl "$LOCALOY_BASE_URL/webhooks/deliveries?status=FAILED&partnerId=$LOCALOY_PARTNER_ID" \
  -H "Authorization: Bearer $LOCALOY_PROVIDER_KEY"

Response · 200

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "cm8d3l1v3ry0000000000001",
        "endpointId": "cm8wh00k0000000000000001",
        "partnerId": "cm1partnerid000000000000001",
        "endpointUrl": "https://hooks.example.com/localoy",
        "eventId": "evt_mfz3k2a1Xq9vT0bLm3Rk",
        "event": "booking.created",
        "status": "FAILED",
        "attempts": 6,
        "nextAttemptAt": null,
        "responseStatus": 503,
        "lastError": "Receiver returned 503",
        "isTest": false,
        "…": "…"
      }
    ],
    "total": 1,
    "limit": 25,
    "offset": 0
  }
}