Webhook Reservation

This documents the webhook payload that Host Tools will POST to your configured webhook URL
when reservation-related events occur.

Note: This is not an API endpoint you call.
This documents the requests that Host Tools sends TO your webhook URL.

When triggered:

  • reservation.created: Host Tools has a new reservation, inquiry or booking request.
  • reservation.cancelled: the reservation's status changed to "cancelled", on any channel. A reservation Host Tools first learns of after it was already cancelled is also sent as reservation.cancelled.
  • reservation.changed: any other change, for example the status moved to "accepted", the dates or number of guests changed, or a change request was opened on an Airbnb reservation.

Each change is sent as its own webhook, so a cancel is never folded into a reservation.changed, even when something else changed at the same moment. document is the reservation as it is when the webhook is sent, so it can already show a later change than the one event describes; read event to know what happened, and document for the current state.

Handling the webhook:

  1. Your endpoint should respond with HTTP 200 status
  2. Process the data asynchronously if needed
  3. Respond within 30 seconds
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Webhook payload sent by Host Tools

Reservation webhook payload sent to user's webhook URL when reservation data changes

string
enum
required

Webhook type

Allowed:
string
enum
required

What happened. reservation.created: Host Tools has a new reservation. reservation.cancelled: the reservation was cancelled, including one Host Tools first sees already cancelled. reservation.changed: anything else, for example new dates, a different number of guests, another status change, a guest's request to cancel (cancellationRequestedDate) or its withdrawal, or a new Airbnb change request (alterationRequest). The reservation's events list what changed: look for the ones newer than the last webhook you handled for it.

Allowed:
document
object
required
Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json