Subscribe a URL to events

Returns the signing secret once. Store it: it is never shown
again, and rotate-secret is the only way to get a new one.

Subscribing to some events also requires an extra scope, or the call
answers 403 WEBHOOK_EVENT_NOT_PERMITTED:

  • booking.* also requires bookings:read:all — the stream covers
    every booking of the property, not just the ones this key created.
  • unit.* also requires housekeeping:read — the scope of
    GET /units/{unit}/housekeeping, where every unit event's url
    points.

A key limited to some properties must send property_ids, and only
its own. The url must be https and resolve to a public address;
anything else is an ordinary validation failure on url.

Scope: webhooks:write, plus bookings:read:all for booking events
and housekeeping:read for unit events

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uri
required
length ≤ 2048

https, resolving to a public address.

events
array of strings
required
length ≥ 1
events*
property_ids
array of uuids
property_ids
string | null
Responses

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