Category:Webhooks: Difference between revisions

Jump to navigation Jump to search
← Older edit
No edit summary
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:API]]
[[Category:API_V2]]
[[Category:Developers]]
<div class="heading">Webhooks</div>
<div class="heading">Webhooks</div>


  This page gives a a general overview over web hooks.
  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.
= Version 1 Booking Webhook =
V1 booking webhooks use the GET method


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.
Triggered on a new or modification to an existing booking.
 
<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
 
Webhook URL's are specified per property so you can transmit information to identify the property in the URL
 
<code> <nowiki>https://yourdomain.com/page?property=1</nowiki></code>
<code> <nowiki>https://yourdomain.com/page?property=2</nowiki></code>
 
<code> <nowiki>https://yourdomain.com/page?property=3</nowiki></code>
 
Template variables can also be used in the URL
 
<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 ==


V2 booking webhooks use the POST method


= 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.


Triggered on a new or modification to an existing booking
Technical documentation can be found here https://api.beds24.com/v2/#/Webhooks/postWebhooks___bookings


= Auto Action Webhook =
= Auto Action Webhook =
Triggered when an auto action triggers.


Triggered when an auto action triggers
Setup: {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS


= Inventory Webhook =
= Inventory Webhook =
Triggered when room inventory or price changes.
Setup: {{#fas:cog}} (SETTINGS) MARKETPLACE > WEBHOOKS


Triggered when room inventory or price changes
More information can be found here [https://wiki.beds24.com/index.php/Inventory_Webhooks Inventory Webhooks]
Retrieved from "https://wiki.beds24.com/index.php/Category:Webhooks"