This documents the webhook payload that Host Tools will POST to your configured webhook URL when it learns of a new review.
Note: This is not an API endpoint you call.
This documents the requests that Host Tools sends TO your webhook URL.
When triggered:
review.createdwithdocument.reviewer"guest": a guest reviewed their stay on Airbnb, Booking.com or VRBO. Host Tools checks for new guest reviews in the background, so this can come some time after the guest posted it.review.createdwithdocument.reviewer"host": the host reviewed the guest on Airbnb or VRBO, through /api/leaveReview, a review message rule, or on the channel itself.
Each review is sent once. A review posted more than 30 days before Host Tools picked it up (an old stay synced for the first time) is not sent; a review with no date (VRBO host reviews) counts from the stay's check-out instead. comments, rating and categoryRatings are included when Host Tools has them: VRBO only reports that the host left a review, not what it said, so a VRBO host review arrives without them. The same review can also be read later with /api/getReviews/{listingID} (guest reviews only).
Handling the webhook:
- Your endpoint should respond with HTTP 200 status
- Process the data asynchronously if needed
- Respond within 30 seconds
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||