--- title: "Configure webhooks" sidebar: apaleo_docs_sidebar permalink: /guides/webhook/configuration.html redirect_from: - "/guides/start/webhook/configuration" --- Webhooks can be configured for as many topics and properties as you would like. All you need to do is to 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 the events from which topic you want to receive. A topic is a grouping of 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 an `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 an `amended` event when the stay-related data is amended, such as services, rate plan, stay dates, etc. | | | changed | You will receive a `changed` event when anything other than stay details is changed in a reservation, such as name, comments, or additional guests. | | | 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. | | | check-in-reverted | You will receive a `check-in-reverted` event when a reservation is moved from the InHouse status back to confirmed. | | | 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. | | | unit-locked | You will receive a `unit-locked` event when a unit assignment is locked. | | | unit-unlocked | You will receive a `unit-unlocked` event when a unit assignment is unlocked. | | | payment-account-set | You will receive a `payment-account-set` event when 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. | | | picked-up-from-block | You will receive a `picked-up-from-block` event when a reservation is picked from a block. | | | 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. | | | payment-account-set | You will receive a `payment-account-set` event when payment account details are added or updated for a booking. | | 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. | | | set-to-optional | You will receive a `set-to-optional` event when a block is set-to-optional. | | | 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. | | | archived | You will receive a `archived` event when a unit is archived. | | 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. | | unitattributedefinition | created | You will receive a `created` event when a unit attribute definition is created. | | | changed | You will receive a `changed` event when a unit attribute definition is changed. | | | deleted | You will receive a `deleted` event when a unit attribute definition 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 to or less than) for a charge is posted to the folio. | | | deposit-item-added | You will receive a `deposit-item-added` event when a deposit item is added. | | | deposit-item-changed | You will receive a `deposit-item-changed` event when a deposit item is changed. | | | deposit-item-deleted | You will receive a `deposit-item-deleted` event when a deposit item is deleted. | | | 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 an 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 an invoice is created. | | | canceled | You will receive a `canceled` event when an invoice is canceled. | | | paid | You will receive a `paid` event when an invoice is paid. | | | written-off | You will receive a `written-off` event when an invoice is written off. | | | signed | You will receive a `signed` event when a **fiscal** invoice is signed by authorities. | | | rendered | You will receive a `rendered` event when a **fiscal** invoice is rendered. | | | failed | You will receive a `failed` event when an invoice has failed. | | 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. | | | 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 the night audit has succeeded. | | | failed | You will receive a `failed` event if the 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. | | | 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. | | paymenttransaction | authorized | You will receive an `authorized` event when a new `Authorized` event has been added to the payment transaction. | | | refused | You will receive a `refused` event when a new `Refused` event has been added to the payment transaction. | | | authorization-adjusted | You will receive an `authorization-adjusted` event when a new `AuthorizationAdjusted` event has been added to the payment transaction. | | | cancelled | You will receive a `cancelled` event when a new `Cancelled` event has been added to the payment transaction. | | | expired | You will receive an `expired` event when a new `Expired` event has been added to the payment transaction. | | | cancellation-denied | You will receive a `cancellation-denied` event when a new `CancellationDenied` event has been added to the payment transaction. | | | sent-for-settle | You will receive a `sent-for-settle` event when a new `SentForSettle` event has been added to the payment transaction. | | | capture-denied | You will receive a `capture-denied` event when a new `CaptureDenied` event has been added to the payment transaction. | | | sent-for-settle-reversed | You will receive a `sent-for-settle-reversed` event when a new `SentForSettleReversed` event has been added to the payment transaction. | | | sent-for-refund | You will receive a `sent-for-refund` event when a new `SentForRefund` event has been added to the payment transaction. | | | refund-denied | You will receive a `refund-denied` event when a new `RefundDenied` event has been added to the payment transaction. | | | refunded** | You will receive a `refunded` event when a new `Refunded` event has been added to the payment transaction. | | | sent-for-refund-reversed | You will receive a `sent-for-refund-reversed` event when a new `SentForRefundReversed` event has been added to the payment transaction. | | | refund-reversed | You will receive a `refund-reversed` event when a new `RefundReversed` event has been added to the payment transaction. | | | settled** | You will receive a `settled` event when a new `Settled` event has been added to the payment transaction. | | | dispute-opened** | You will receive a `dispute-opened` event when a new `DisputeOpened` event has been added to the payment transaction. | | | dispute-information-requested** | You will receive a `dispute-information-requested` event when a new `DisputeInformationRequested` event has been added to the payment transaction. | | | dispute-information-supplied** | You will receive a `dispute-information-supplied` event when a new `DisputeInformationSupplied` event has been added to the payment transaction. | | | fraud-detected** | You will receive a `fraud-detected` event when a new `FraudDetected` event has been added to the payment transaction. | | | dispute-lost** | You will receive a `dispute-lost` event when a new `DisputeLost` event has been added to the payment transaction. | | | dispute-won** | You will receive a `dispute-won` event when a new `DisputeWon` event has been added to the payment transaction. | | | settled-on-merchant-account** | You will receive a `settled-on-merchant-account` event when a new `SettledOnMerchantAccount` event has been added to the payment transaction. | | | refunded-from-merchant-account** | You will receive a `refunded-from-merchant-account` event when a new `RefundedFromMerchantAccount` event has been added to the payment transaction. | | | charged-back** | You will receive a `charged-back` event when a new `ChargedBack` event has been added to the payment transaction. | | | charged-back-from-merchant-account** | You will receive a `charged-back-from-merchant-account` event when a new `ChargedBackFromMerchantAccount` event has been added to the payment transaction. | | | chargeback-reversed** | You will receive a `chargeback-reversed` event when a new `ChargebackReversed` event has been added to the payment transaction. | | | chargeback-reversed-on-merchant-account** | You will receive a `chargeback-reversed-on-merchant-account` event when a new `ChargebackReversedOnMerchantAccount` event has been added to the payment transaction. | | | second-time-charged-back** | You will receive a `second-time-charged-back` event when a new `SecondTimeChargedBack` event has been added to the payment transaction. | | | second-time-charged-back-from-merchant-account** | You will receive a `second-time-charged-back-from-merchant-account` event when a new `SecondTimeChargedBackFromMerchantAccount` event has been added to the payment transaction. | \* 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 a property filter. \** Only available for Apaleo Pay accounts. 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.