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.

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	Description
account	set-to-live*	You will receive a `set-to-live` event when an account is live.
	suspended*	You will receive a `suspended` event when an account is suspended.
property	created*	You will receive a `created` event when a new property is created.
	changed	You will receive a `changed` event when property settings are changed like description, address, and so on.
	set-to-live	You will receive a `set-to-live` event when a property is live.
	archived	You will receive a `archived` event when a property is archived.
	deleted	You will receive a `deleted` event when a property is deleted.
reservation	created	You will receive a `created` event when a new reservation is created.
	amended	You will receive a `amended` event when the stay dates are amended.
	changed	You will receive a `changed` event when anything other than stay is changed in a reservation.
	checked-in	You will receive a `checked-in` event when a reservation is checked-in.
	checked-out	You will receive a `checked-out` event when a reservation is checked-out.
	set-to-no-show	You will receive a `set-to-no-show` event when a reservation is marked as no-show.
	unit-assigned	You will receive a `unit-assigned` event when a unit is assigned to a reservation.
	unit-unassigned	You will receive a `unit-unassigned` event when a unit is unassigned from a reservation.
	city-tax-added	You will receive a `city-tax-added` event when a city tax is added for a reservation.
	city-tax-removed	You will receive a `city-tax-removed` event when a city tax is removed from a reservation.
	payment-account-set	You will receive a `payment-account-set` event when a payment account details are added or updated for a reservation.
	payment-account-removed	You will receive a `payment-account-removed` event when a payment account is removed from a reservation.
	canceled	You will receive a `canceled` event when a reservation is canceled.
	deleted	You will receive a `deleted` event when a reservation is deleted.
booking	created*	You will receive a `created` event when a booking is created.
	changed*	You will receive a `changed` event when a booking is changed.
	deleted*	You will receive a `deleted` event when a booking is deleted.
company	created	You will receive a `created` event when a company is created.
	changed	You will receive a `changed` event when a company is changed.
	deleted	You will receive a `deleted` event when a company is deleted.
group	created	You will receive a `created` event when a group is created.
	changed	You will receive a `changed` event when a group is changed.
	deleted	You will receive a `deleted` event when a group is deleted.
block	created	You will receive a `created` event when a block is created.
	changed	You will receive a `changed` event when a block is changed.
	deleted	You will receive a `deleted` event when a block is deleted.
	confirmed	You will receive a `confirmed` event when a block is confirmed.
	released	You will receive a `released` event when a block is released.
	washed	You will receive a `washed` event when a block is washed.
	cancelled	You will receive a `cancelled` event when a block is cancelled.
unit	created	You will receive a `created` event when a unit is created.
	changed	You will receive a `changed` event when a unit is changed.
	deleted	You will receive a `deleted` event when a unit is deleted.
unitgroup	created	You will receive a `created` event when a unit group is created.
	changed	You will receive a `changed` event when a unit group is changed.
	deleted	You will receive a `deleted` event when a unit group is deleted.
folio	created	You will receive a `created` event when a folio is created.
	closed	You will receive a `closed` event when a folio is closed.
	balance-changed	You will receive a `balance-changed` event when there are changes in the folio balance.
	reopened	You will receive a `reopened` event when a folio is reopened.
	deleted	You will receive a `deleted` event when a folio is deleted.
	charges-changed	You will receive a `charges-changed` event when a charge is added to the folio.
	charge-posted	You will receive a `charge-posted` event when a charge is posted to the folio.
	debitor-changed	You will receive a `debitor-changed` event when a debitor is changed in the folio.
	transitory-charge-posted	You will receive a `transitory-charge-posted` event when a transitory charge is posted to the folio.
	allowance-posted	You will receive a `allowance-posted` event when an allowance (equal or less) for a charge is posted to the folio.
	payment-added	You will receive a `payment-added` event when a payment is added to the folio.
	payment-posted	You will receive a `payment-posted` event when a payment is posted to the folio.
	payment-failed	You will receive a `payment-failed` event when a payment fails.
	payment-canceled	You will receive a `payment-canceled` event when a payment is canceled.
	refund-added	You will receive a `refund-added` event when a payment refund is added to the folio.
	refund-posted	You will receive a `refund-posted` event when a payment refund is posted to the folio.
	refund-failed	You will receive a `refund-failed` event when a payment refund fails.
	charge-moved-from-folio	You will receive a `charge-moved-from-folio` event when a charge is moved from one folio to another.
	transitory-charge-moved-from-folio	You will receive a `transitory-charge-moved-from-folio` event when a transitory charge is moved from one folio to another.
	payment-moved-from-folio	You will receive a `payment-moved-from-folio` event when a payment is moved from one folio to another.
	refund-moved-from-folio	You will receive a `refund-moved-from-folio` event when a refund is moved from one folio to another.
	charge-moved-to-folio	You will receive a `charge-moved-to-folio` event when a charge is successfully moved to the other folio.
	transitory-charge-moved-to-folio	You will receive a `transitory-charge-moved-to-folio` event when a transitory charge is successfully moved to the other folio.
	payment-moved-to-folio	You will receive a `payment-moved-to-folio` event when a payment is successfully moved to the other folio.
	refund-moved-to-folio	You will receive a `refund-moved-to-folio` event when a refund is successfully moved to the other folio.
	allowance-moved-to-folio	You will receive a `allowance-moved-to-folio` event when a allowance is moved to the other folio.
	allowance-moved-from-folio	You will receive a `allowance-moved-from-folio` event when a charge is moved from one folio to another.
invoice	created	You will receive a `created` event when a invoice is created.
	canceled	You will receive a `canceled` event when a invoice is canceled.
	paid	You will receive a `paid` event when a invoice is paid.
	written-off	You will receive a `written-off` event when a invoice is written off.
rateplan	created	You will receive a `created` event when a rate plan is created.
	changed	You will receive a `changed` event when a rate plan is changed.
	rate-changed	You will receive a `rate-changed` event when a rate (price) is changed.
	deleted	You will receive a `deleted` event when a rate plan is deleted.
nightaudit	started	You will receive a `started` event when night audit starts.
	succeeded	You will receive a `succeeded` event when night audit has succeeded.
	failed	You will receive a `failed` event if night audit has failed.
maintenance	created	You will receive a `created` event when a maintenance slot is created.
	changed	You will receive a `changed` event when a maintenance slot is changed.
	deleted	You will receive a `deleted` event when a maintenance slot is deleted.
citytax	created	You will receive a `created` event when a city tax is created.
	changed	You will receive a `changed` event when a city tax is changed.
	vat-modified	You will receive a `vat-modified` event when a city tax vat is changed. This event will be removed on the 1st of December 2022, please use `changed` event instead.
	deleted	You will receive a `deleted` event when a city tax is deleted.
service	created	You will receive a `created` event when a service is created.
	changed	You will receive a `changed` event when a service is changed.
	deleted	You will receive a `deleted` event when a service is deleted.

* 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.