Skip to navigation
Open APIOpen APIWebhooks Management

Get webhook by id

Path parameters

idstringRequired
Webhook id

Headers

AuthorizationstringRequired

Bearer access token. See Authentication endpoint for details.

Response

The webhook document
_idstringOptional
namestringOptional
eventstringOptional

Event key. See Appendix - Webhook events.

urlstringOptional
conditionslist of objectsOptional
dataPointslist of stringsOptional

See Appendix - Webhook data points.

isEnabledbooleanOptionalDefaults to true
headerslist of objectsOptional
brandslist of stringsOptional

Brand ids (ObjectId as string) to limit delivery

valueNameToComparestringOptional

Used for specific events like reservationDetailsUpdated to target ETA/ETD/stayDateChanged

notifyOnWebhookFailuresbooleanOptional
Email notification on webhook failures
failureNotificationEmailslist of stringsOptional
Email addresses to notify on webhook failures

Errors

400
Bad Request Error