Difference between revisions of "Category:Webhooks"
Markkinchin (talk | contribs) |
Markkinchin (talk | contribs) |
||
Line 8: | Line 8: | ||
= Booking Webhook = | = Booking Webhook = | ||
Triggered on a new or modification to an existing booking. | Triggered on a new or modification to an existing booking. | ||
+ | |||
+ | Webhooks are asynchronous and there can be a small variable delay between a change and a webhook being sent (an average delay of one minute is to be expected). They are not an instant notification. | ||
Setup: {{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS | Setup: {{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS |
Revision as of 10:06, 18 December 2023
This page gives a a general overview over web hooks.
Webhooks are small messages sent from our server to yours, they can be used to trigger an action on your server in a timely manner, for example to retrieve a new booking via API.
1 Booking Webhook
Triggered on a new or modification to an existing booking.
Webhooks are asynchronous and there can be a small variable delay between a change and a webhook being sent (an average delay of one minute is to be expected). They are not an instant notification.
Setup: (SETTINGS) PROPERTIES > ACCESS
Webhook URL's are specified per property so you can transmit information to identify the property in the URL
https://yourdomain.com/page?property=1
https://yourdomain.com/page?property=2
https://yourdomain.com/page?property=3
Template variables can also be used in the URL
https://yourdomain.com/page?property=[PROPERTYID]
Note: ensure any information included in the URL by template variable is suitable for a URL, for example guest names may contain characters that are not allowed in URL's and may cause the webhook to fail.
1.1 Version 2 Booking Webhook
Booking webhooks can contain the booking data as a JSON object in their body. This can mean in many cases there is no need to make any additional API call after receiving the webhook.
This is currently a Beta function, please contact support if you wish to use it
2 Auto Action Webhook
Triggered when an auto action triggers.
Setup: (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS
3 Inventory Webhook
Triggered when room inventory or price changes.
Setup: (SETTINGS) APPS & INTEGRATIONS > WEBHOOKS
Pages in category "Webhooks"
The following 4 pages are in this category, out of 4 total. download this selection of articles as a PDF book