Create a subscription
You register an HTTPS endpoint and the events it receives. You receive the signing secret only in this response; store it on your server. Your organization holds at most five subscriptions, one per URL, shared by all its credentials.
Your API key. Issued and revoked from the TrustPixel dashboard; the gateway resolves it to an owning organization on every request.
In: header
Header Parameters
Correlation id echoed to the upstream service and returned on the response. Generated as req_<uuid> when omitted.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/hotel/webhook-subscriptions" \ -H "Content-Type: application/json" \ -d '{ "url": "string", "event_types": [ "hotel.booking.confirmed" ] }'{ "data": { "id": "string", "url": "string", "event_types": [ "hotel.booking.confirmed" ], "status": "ACTIVE", "previous_secret_expires_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "signing_secret": "string" }}List your subscriptions GET
You receive your organization's subscriptions, oldest first, without their signing secrets.
Change a subscription PATCH
You change the URL, the events or the status. A paused subscription receives no new events, and events that occur while it is paused are not sent later. Requests already queued, including their retries, still arrive at the URL they were queued with.