Webhook Listing

This documents the webhook payload that Host Tools will POST to your configured webhook URL when a listing is added, changed or deleted.

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

When triggered:

  • listing.created: a listing is added (imported or created)
  • listing.changed: a field returned by /api/getListing changes (for example the name, description, photos, prices or settings). Several edits within 30 seconds are sent as one webhook with the latest data.
  • listing.deleted: a listing is deleted

A listing joining or leaving a listing group is sent as listingGroup.changed, not listing.changed.

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
Allowed:
string
enum
required
Allowed:
document
required

For listing.created and listing.changed, the listing as /api/getListing/{listingID} returns it at the time of sending. For listing.deleted, only _id and userID.

Response

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