Category:Webhooks: Difference between revisions
Jump to navigation
Jump to search
Markkinchin (talk | contribs) |
No edit summary |
||
| Line 2: | Line 2: | ||
<div class="heading">Webhooks</div> | <div class="heading">Webhooks</div> | ||
This page gives a a general overview over | This page gives a a general overview over webhooks. | ||
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. | 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. | ||
| Line 9: | Line 9: | ||
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. | <span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}} </span> 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 | ||
| Line 25: | Line 25: | ||
<code> <nowiki>https://yourdomain.com/page?property=[PROPERTYID]</nowiki></code> | <code> <nowiki>https://yourdomain.com/page?property=[PROPERTYID]</nowiki></code> | ||
<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}} </span> 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. | |||
== Version 2 Booking Webhook == | == Version 2 Booking Webhook == | ||