Webhooks
Overview of the Webhook notifications provided by Guesty.
Guesty's Open API allows you to send various webhook notifications to your application's notification URL(s).
Figure 1: Webhook Subscription Flow.
A webhook is a mechanism that allows an app to send real-time data to other apps. A webhook sends data to other applications in real-time, so you get it immediately. This structure makes webhooks way more efficient than the traditional way of requesting data from an API endpoint for some use cases.
Understanding and consuming webhooks is essential in getting the best out of Guesty's Open API.
Why Create Webhooks?
Once your Guesty Open API integration is complete and finished with its initial data synchronization, we recommend you utilize webhook notifications to stay up-to-date. Webhook notifications will help you save time and resources, and in addition, you can synchronize only the data that has changed and ignore that which has remained in the same state since the initial synchronization.
For instance, you can create a webhook for new reservations and be notified each time a new reservation is created. Our Open API offers a wide variety of webhook events in addition to new reservation notifications.
Table of Supported Webhooks
The following table summarizes the Webhooks that Guesty makes available, with links to more detailed guides for each type.
| Webhook Domain | Webhook Event |
|---|---|
| Reservation Webhooks | reservation.new, reservation.updated |
| Message Webhooks | reservation.messageReceived, reservation.messageSent |
| Payment Webhooks | payments.received, payments.failed, payments.refunded, payments.overdue, payments.overcharged, payments.overcharge.expected, payments.authenticationRequired, payments.authorizationHoldFailed, payments.disputes |
| Listing Webhooks | listing.new, listing.updated, listing.removed |
| Calendar Webhooks | listing.calendar.updated |
| Task Webhooks | task.created, task.updated, task.deleted |
| Guest Webhooks | guest.created, guest.updated, guest.deleted |
FAQs
What is considered an error on the part of the recipient endpoint?
The nature of a webhook is that it doesn't wait for a reply from the recipient. If the recipient is unresponsive, the delivery will fail.
How many delivery attempts does Guesty make when the recipient is unresponsive?
When the recipient is unresponsive, Guesty will perform up to two delivery attempts within the space of one hour. If the recipient remains unresponsive, the delivery will fail.
How long after an event will I receive the webhook?
Webhooks can be received from a few seconds to 30 minutes after the event has taken place on your Guesty account. If you're encountering delays in excess of half an hour, please contact support
Why am I receiving two webhooks for the same reservation update?
To ensure all reservation changes are captured after the event, two webhooks are generated. They differ in content, and we recommend you analyze their schema and content to map with your systems.
Why am I receiving webhooks for old Airbnb messages?
When a property is imported from Airbnb or linked with an existing Airbnb listing, Guesty will import past, current, and future reservations and their related conversation threads. Since these conversations are new to Guesty, they will trigger the reservations.messageReceived webhook. Learn how Guesty syncs with the booking channels here.
Why don't new reservations trigger calendar webhooks?
Currently, our webhooks only include specific updates. The listing.calendar.updated event will be triggered only under the following circumstances:
- Changes in availability through calendars.
- Updates to nightly rates.
- Alterations to the minimum stay requirement.
This does not include notifications for calendar updates caused by new or altered reservations.
Updated 3 months ago