Configuration
Un webhook est enregistré avec une URL spécifique pour un événement (Event) précis lié à une entité (Entity) spécifique.
Actuellement, les entités et événements suivants sont pris en charge :
Entité : BOOKING
CREATED
CHECKED_IN
CANCELED
Entité : EVENT_BOOKING
CREATED
CANCELED
Payload
Lorsqu’un webhook est déclenché, une requête POST est envoyée à l’URL enregistrée avec un payload au format JSON.
Chaque requête contient l’objet JSON suivant. Le contenu du champ data dépend de l’événement.
{ "clientId": "<CLIENT ID>", "entity": "<ENTITY NAME>", "event": "<EVENT NAME>", "data": { <EVENT SPECIFIC PAYLOAD> } }
Entité : BOOKING
CREATED
Déclenché lorsqu’une réservation est créée.
Exemple :
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "BOOKING", "event": "CREATED", "data": <Booking> }Voir la documentation API pour le détail de l’objet <Booking>.
CHECKED_IN
Déclenché lorsqu’une réservation est enregistrée (check-in).
Exemple :
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "BOOKING", "event": "CHECKED_IN", "data": <Booking> }Voir la documentation API pour le détail de l’objet <Booking>.
CANCELED
Déclenché lorsqu’une réservation est annulée.
Exemple :
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "BOOKING", "event": "CANCELED", "data": <Booking> }Voir la documentation API pour le détail de l’objet <Booking>.
Entité : EVENT_BOOKING
CREATED
Déclenché lorsqu’une réservation d’événement est créée.
Exemple :
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "EVENT_BOOKING", "event": "CREATED", "data": <Event Booking> }Voir la documentation API pour le détail de l’objet <Event Booking>.
CANCELED
Déclenché lorsqu’une réservation d’événement est annulée.
Exemple :
{ "clientId": "5c7bc6f6161f0b2e10555060", "entity": "EVENT_BOOKING", "event": "CANCELED", "data": <Event Booking> }Voir la documentation API pour le détail de l’objet <Event Booking>.