Setup
A webhook is registered with a specific URL for a specific Event of a specific Entity.
Currently, the following entities and events are supported:
calendar_monthBOOKING
CREATED
CHECKED_IN
CANCELED
eventEVENT_BOOKING
CREATED
CANCELED
Payload
When a webhook is triggered, a POST request is sent to the registered URL with a JSON payload.
Every request will include the following JSON-object. The content of the "data"-field is event specific.
{ "clientId":"<CLIENT ID>", "entity":"<ENTITY NAME>", "event":"<EVENT NAME>", "data":{<EVENT SPECIFIC PAYLOAD>} }
Entities
calendar_monthBooking
Entity name: BOOKING
CREATED
Triggers when a booking is created.
Example:
{ "clientId":"5c7bc6f6161f0b2e10555060", "entity":"BOOKING", "event":"CREATED", "data":<Booking> (See API documentation for details) }
CHECKED_IN
Triggers when a booking is checked in.
Example:
{ "clientId":"5c7bc6f6161f0b2e10555060", "entity":"BOOKING", "event":"CHECKED_IN", "data":<Booking> (See API documentation for details) }
CANCELED
Triggers when a booking is canceled.
Example:
{ "clientId":"5c7bc6f6161f0b2e10555060", "entity":"BOOKING", "event":"CANCELED", "data":<Booking> (See API documentation for details) }
eventEvent Booking
Entity name: EVENT_BOOKING
CREATED
Triggers when a event booking is created.
Example:
{ "clientId":"5c7bc6f6161f0b2e10555060", "entity":"EVENT_BOOKING", "event":"CREATED", "data":<Event Booking> (See API documentation for details) }
CANCELED
Triggers when a event booking is canceled.
Example:
{ "clientId":"5c7bc6f6161f0b2e10555060", "entity":"EVENT_BOOKING", "event":"CANCELED", "data":<Event Booking> (See API documentation for details) }