Create
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/webhook';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: 'null'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/webhook \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullRegisters a new webhook subscription for the managing entity and returns the persisted record.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Identifier of the managing entity that will own the webhook
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Webhook configuration including the target callback URL, signing secret, and the list of event types to subscribe to
Request payload for creating or updating a webhook subscription, including the target endpoint URL, owning entity, and the list of event types to subscribe to.
object
Descriptive name of this webhook, e.g. ‘Booking confirmation sync’ or ‘Payment notifications’.
Example
Booking confirmation syncThe managing entity (account owner) that will own this webhook.
object
Unique managing entity (account owner) identifier.
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Display name of the managing entity.
Example
The Siam Residences, BangkokExample
{ "identifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "name": "The Siam Residences, Bangkok"}Whether this webhook is actively subscribed to events.
Example
trueHTTPS endpoint URL to POST events to. Must be a valid, publicly accessible URL.
Example
https://api.example.com/webhooks/wink/eventsExample
{ "name": "Booking confirmation sync", "entity": { "identifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "name": "The Siam Residences, Bangkok" }, "enabled": true, "eventUrl": "https://api.example.com/webhooks/wink/events", "eventList": [ "booking.created" ]}Responses
Section titled “Responses”Webhook created successfully
Lightweight projection of a webhook subscription that delivers HTTP POST notifications to a configured endpoint whenever subscribed events occur on the Wink platform.
object
Unique identifier for this record.
Datetime this record was first created
Datetime this record was last updated
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Unique authenticated user identifier
Unique managing entity (owner) identifier
Display name of the managing entity that owns this webhook.
Descriptive name of this webhook, e.g. ‘Booking confirmation sync’ or ‘Payment notifications’.
Whether this webhook is actively subscribed to events.
HTTPS endpoint URL to POST events to.
Example
Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable