Link

Configure webhooks

Webhooks can be configured for as many topics and properties as you would like. All you need to do is create a subscription by making a POST request to the Webhook API.

POST https://webhook.apaleo.com/v1/subscriptions

These subscriptions tell apaleo which events your particular app would like to receive.

Note: You must subscribe to events in your app rather than subscribe to them through Webhook API Swagger reference.

Important considerations

We recommend that your webhook URLs be protected using basic authentication or HTTPS.

It also needs to be reachable from apaleo.com. If you’re not sure, check with your security or ops team, if any firewalls prevent incoming traffic on (usually) port 443, and ask to whitelist us.

Our outbound IP addresses are:

34.240.36.71
52.212.76.75
63.33.249.221

Events

When subscribing, you can choose events from which topic you want to receive. A topic is grouping events of several types. The available events are:

TOPIC TYPE
Reservation created
  amended
  changed
  checked-in
  checked-out
  set-to-no-show
  unit-assigned
  unit-unassigned
  canceled
Booking* created
  changed
  deleted
Company created
  changed
  deleted
Group created
  changed
  deleted
Block created
  changed
  deleted
  confirmed
  released
  washed
  cancelled
Unit created
  changed
  deleted
UnitGroup created
  changed
  deleted
Folio created
  closed
  balance-changed
  reopened
  deleted
  charge-posted
  debitor-changed
  transitory-charge-posted
  allowance-posted
  payment-posted
  refund-posted
  charge-moved-from-folio
  transitory-charge-moved-from-folio
  payment-moved-from-folio
  refund-moved-from-folio
  charge-moved-to-folio
  transitory-charge-moved-to-folio
  payment-moved-to-folio
  refund-moved-to-folio
Invoice created
  canceled
RatePlan created
  rate-changed
NightAudit started
  succeeded
  failed
System healthcheck

* When subscribing to these events make sure to leave propertyIds empty. Since these are account-level events, they will not be delivered for subscriptions with property filter.

The list of types within one topic can grow in the future, make sure your implementation is ready for unexpected event types appearing in the payloads.