Docs
Get an API key
Hotel webhooks

List a subscription's deliveries

GET
/v1/hotel/webhook-subscriptions/{id}/deliveries

You receive the subscription's deliveries, newest first, each with its event and your endpoint's responses for the current replay. Filter by status to find failed or stuck deliveries.

Authorization

x-api-key<token>

Your API key. Issued and revoked from the TrustPixel dashboard; the gateway resolves it to an owning organization on every request.

In: header

Path Parameters

id*string
Match^whs_[a-zA-Z0-9-]+$
Lengthlength <= 128

Query Parameters

limit?integer
Range1 <= value <= 100
Default25
offset?|
Range0 <= value <= 100000
Default0
status?string

Value in

  • "PENDING"
  • "PUBLISHED"
  • "DELIVERED"
  • "FAILED"

Header Parameters

x-request-id?string

Correlation id echoed to the upstream service and returned on the response. Generated as req_<uuid> when omitted.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/hotel/webhook-subscriptions/string/deliveries"
{  "data": [    {      "id": "string",      "status": "PENDING",      "event": {        "id": "string",        "type": "string",        "created_at": "string",        "data": {          "booking": {            "property1": null,            "property2": null          }        }      },      "replay_count": 0,      "failure_reason": "retries_exhausted",      "attempts": [        {          "attempt_number": 0,          "response_status": 0,          "response_body": "string",          "created_at": "2019-08-24T14:15:22Z"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "published_at": "2019-08-24T14:15:22Z",      "delivered_at": "2019-08-24T14:15:22Z",      "failed_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "limit": 0,    "offset": 0  }}

Rotate the signing secret POST

You receive a new signing secret, only in this response. For 24 hours new requests carry a signature for each secret; keep accepting your previous secret for at least 2 hours 15 minutes, because requests queued before the rotation carry only its signature. Rotating again replaces the previous secret.

Replay a delivery POST

You send the same event again with a fresh signature. You can replay a delivered or failed delivery, a delivery pending for more than one minute, or one published more than 2 hours 15 minutes ago without a result. Your subscription must be active. Your endpoint can receive the event again, so ignore repeats by event ID.