An event is an occurrence, such as a booking being made or an invoice being marked as paid. Each occurrence has a corresponding Event
.
Webhook endpoints are URLs defined by users to which our Webhooks sends events. A single event may be sent to many webhook endpoints.
Webhooks refers to the overall concept of sending notifications to webhook endpoints.
Interacting with a third-party API like a booking form can introduce two problems:
Webhooks solve these problems by letting you register a URL that we will notify anytime an event happens on any of the properties you're marked as a manager of. When the event occurs—for example, when a booking is created by a receptionist, our system triggers an Event
.
You might use webhooks as the basis to:
Webhooks allow us to update you without you needing to add any code to our website.
If you are setting up a remote site to receive data sent from our system, you are strongly advised to use TLS ( successor to SSL ) to receive data sent from our site.
If you think that your Username/password/API keys have been compromised, you should change them immediately on your remote site. Once that's done, you can easily update your Webhooks here with the new authentication details. Changes are applied immediately.
The webhook system allows you to update a remote site when something happens on one of your properties.
You can create an unlimited number of Webhooks, each going to different sites. A variety of Authentication methods are available, including No authentication, basic authentication and Oauth2 based authentication.
To acknowledge receipt of a webhook, your endpoint should return a 2xx HTTP status code. Any other information returned in the request headers or request body is ignored.
When a task has been performed against one of your properties, then we will update your remote service with certain information, for example if a booking is taken we will update your remote site with new availability data for all your room/property types.
[METHODS]
By using our Webhooks, you agree to this policy. We reserve the right to change this policy at any time without notice, so please check it regularly. Your continued use of our Webhooks constitutes acceptance of any changes.
[WEBSITE TERMS AND CONDITIONS]