Webhook Message

This documents the webhook payload that Host Tools will POST to your configured webhook URL when a new post is added to a reservation

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

When triggered:

  • New message/attachment is added to a reservation posts field
  • Messages from either guests or hosts

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

string
enum
required

Webhook type

Allowed:
document
object
required

Message document

Response

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