This documents the webhook payload that Host Tools will POST to your configured webhook URL when something goes wrong after a request has already succeeded, and again when it is fixed.
Note: This is not an API endpoint you call.
This documents the requests that Host Tools sends TO your webhook URL.
When triggered:
-
error.raised: a problem started.document.codesays what:-
account.disconnected: a channel account's login or token stopped
working. The host has to reconnect it. -
account.verificationRequired: VRBO wants the host to verify the
account, or the login is not a host account. -
account.importFailed: an owner-import auto-connect (Airbnb or
VRBO) or the account's auto import couldn't import every listing on
the account into its listing group: some listings failed, or the
import stopped before it finished. The owner is already back on your
redirectby then, so this is how you learn about it. The listings
that did import stay in the group. Auto import retries the rest every
hour, as does sending the owner the link again, and Host Tools
resolves the error once an import of the account gets every listing,
or when auto import is turned off. Auto import raises it again only
when the shortfall changes, not on every retry. -
calendar.syncFailed: a channel refused a price, availability or
minimum-nights change, for example "You can only accept long-term
rentals (30 or more)". /api/setPrices and /api/setListing answer
before the channel does, so this is how you learn about it. -
calendar.downloadFailed: the daily download of a listing's
Airbnb calendar failed, for a listing with pricing and availability
sync off whose user has daily downloads (set by Host Tools support).
The listing'sAirbnb.current*values in Get Calendar stop updating
andchannels.Airbnb.calendarDownloadedAtstops moving until a
download works. The message has Airbnb's reason. Host Tools tries
again every day and resolves the error after a download works,
including the one before each sync once pricing or availability sync
is turned on. It's also resolved when the listing stops being
downloaded daily: switched off, or daily downloads turned off for the
user.actionRequiredisfalse.occurredAtis when it first
failed. -
listing.connectionFailed: Airbnb refused to connect the listing
to Host Tools. -
listing.contentSyncFailed: a channel refused a listing content
push. -
listing.publishFailed: publishing a listing as a new channel
listing (/api/publishListing) failed. The message is the channel's
reason, and what Host Tools created on the channel was deleted, so
the listing can be published again once it's fixed. VRBO can't
delete a property, so a VRBO one stays, and the next publish carries
on with it. -
listing.openFailed: a listing published to Booking.com as a
new property can't be booked yet: Booking.com's checks of the
property fail (for example "Contract is not signed in the legal
entity for the country: us"), or it approved the property but won't
open it. The message is Booking.com's reason. Host Tools checks again
each time calendar sync sends the listing to Booking.com (at least
once a day) and resolves the error once Booking.com moves on, or
once the listing's Booking.com channel is removed. -
message.sendFailed: a scheduled message could not be sent.
willRetrysays whether Host Tools is still trying. A failure Host
Tools is retrying (the channel was briefly down, for example) is
only sent once it has kept failing for about an hour, so a blip the
next try fixes reaches you as nothing at all. -
payouts.unavailable: Airbnb doesn't share payouts with accounts
connected in setup mode (through an owner import link or as a
co-host,fullAccess: falsein Get Accounts), so Host Tools has none
for this account and Get Payouts returns none. It explains a missing
account rather than asking for something, soactionRequiredis
false: payouts become available if the host reconnects with full
access. Host Tools tries again once a day and resolves the error
after a read succeeds.occurredAtis when Airbnb first refused. -
review.submitFailed: a scheduled review could not be left.
-
-
error.resolved: the problem is gone (the account reconnected, the next sync succeeded, the message was sent). Carries the samedocumentplusresolvedAt.
The same problem repeating sends nothing new. A second error.raised for an errorID you already have open replaces its details, for example when a retrying message failure becomes permanent.
Applying the events:
Keep your open errors keyed on document.errorID. Deliveries can arrive out of order (a resolve can overtake a retried raise), so apply them by occurredAt and resolvedAt, and ignore a resolve for an errorID you never saw: problems that started before you subscribed, or before this webhook existed, resolve without a raise. After an outage, call /api/getErrors to get the current list.
OAuth clients only receive the errors their scopes cover. Treat a code you do not know as a generic error.
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… | |||