Configuración
Un webhook se registra con una URL específica para un evento (Event) concreto de una entidad (Entity) determinada.
Actualmente se admiten las siguientes entidades y eventos:
Entidad: BOOKING
CREATED
CHECKED_IN
CANCELED
Entidad: EVENT_BOOKING
CREATED
CANCELED
Payload
Cuando se activa un webhook, se envía una solicitud POST a la URL registrada con un payload en formato JSON.
Cada solicitud incluye el siguiente objeto JSON. El contenido del campo data depende del evento.
{ "clientId": "<CLIENT ID>", "entity": "<ENTITY NAME>", "event": "<EVENT NAME>", "data": { <EVENT SPECIFIC PAYLOAD> } }
Entidad: BOOKING
CREATED
Se activa cuando se crea una reserva.
Ejemplo:
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "BOOKING", "event": "CREATED", "data": <Booking> }Consulte la documentación de la API para más detalles sobre el objeto <Booking>.
CHECKED_IN
Se activa cuando una reserva se registra (check-in).
Ejemplo:
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "BOOKING", "event": "CHECKED_IN", "data": <Booking> }Consulte la documentación de la API para más detalles sobre el objeto <Booking>.
CANCELED
Se activa cuando una reserva se cancela.
Ejemplo:
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "BOOKING", "event": "CANCELED", "data": <Booking> }Consulte la documentación de la API para más detalles sobre el objeto <Booking>.
Entidad: EVENT_BOOKING
CREATED
Se activa cuando se crea una reserva de evento.
Ejemplo:
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "EVENT_BOOKING", "event": "CREATED", "data": <Event Booking> }Consulte la documentación de la API para más detalles sobre el objeto <Event Booking>.
CANCELED
Se activa cuando se cancela una reserva de evento.
Ejemplo:
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "EVENT_BOOKING", "event": "CANCELED", "data": <Event Booking> }Consulte la documentación de la API para más detalles sobre el objeto <Event Booking>.