Difference between revisions of "Inventory Webhooks"
m (Annette moved page Web Hooks to Inventory Webhooks) |
|||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:API]] | [[Category:API]] | ||
| − | [[Category: | + | [[Category:Apps]] |
[[Category:Developers]] | [[Category:Developers]] | ||
| − | [[Category: | + | [[Category:Webhooks]] |
| − | + | <div class="heading">Inventory Webhooks</div> | |
| − | This page is about the menu SETTINGS | + | This page is about the menu {{#fas:cog}} (SETTINGS) APPS & INTEGRATIONS > WEBHOOKS |
| Line 27: | Line 27: | ||
Typical JSON data posted by the web hook request: | Typical JSON data posted by the web hook request: | ||
| − | |||
| + | <code>{"roomId":"123456","propId":"12345","ownerId":"1234","action":"SYNC_ROOM"}</code> | ||
| − | |||
| − | |||
| − | |||
| − | + | You can add your own data in the "Custom Header" field if required including using template variables. The data will be sent as HTTP headers to the remote server with the webhook. | |
| + | |||
| + | |||
| + | <div class="warning">{{#fas:exclamation-triangle}} You can NOT use [https://wiki.beds24.com/index.php?title=Template_Variables Template variables] here as this webhook operates on a room level. [https://wiki.beds24.com/index.php?title=Template_Variables Template variables] are only available in the context of a booking.</div> | ||
Latest revision as of 19:31, 13 March 2024
This page is about the menu (SETTINGS) APPS & INTEGRATIONS > WEBHOOKS
Send a web hook request to your service whenever a room type needs syncing because an availability or price has changed.
Enter the public facing URL to receive the request.
Optional headers can be specified for authentication or other purposes if required.
The web hook request expects an HTTP response code between 200 and 299, if it does not see this it will be retried a number of times over the next 30 minutes before giving up.
Web hooks are triggered by new bookings, modification to booked dates, cancellations, an inventory change or a price change on a room type.
Changes to restrictions like minimum stay do not trigger a web hook.
The web hook request payload contains json data in it's body with the roomId which triggered the request.
This can be used to keep external services synchronised with minimum delay whenever changes occur.
Typical JSON data posted by the web hook request:
{"roomId":"123456","propId":"12345","ownerId":"1234","action":"SYNC_ROOM"}
You can add your own data in the "Custom Header" field if required including using template variables. The data will be sent as HTTP headers to the remote server with the webhook.
