Webhooks
To use this capability add octo/webhooks to your Octo-Capabilities header.
This capability allows you to create webhooks which will notify a given URL whenever an action happens in OCTO Cloud, e.g. Booking Update, Booking Cancellation, or Availability Change.
postCreate Webhook
{"id": "5c7d6dbb-cd4c-48fd-9709-0ebaa14d7a00","event": "booking_update","url": "https://example.com/webhooks/availability_update"}
Field | Description |
| A fully formed URL. If you want to include basic authentication credentials that is supported also. For example:
|
| The event that will trigger the webhook. Possible values are:
|
An example response will look like this:
{"id": "5c7d6dbb-cd4c-48fd-9709-0ebaa14d7a00","event": "booking_update","url": "https://example.com/webhooks/availability_update"}
We recommend for testing you can use ngrok to create an endpoint which connects to your localhost. You can then make test bookings with the same credentials and see the webhook requests arrive.
When an event is triggered the webhook will perform a POST HTTP request to the specified URL, the request body will look like this depending on the event type:
{"webhook": {"id": "59a7aca3-e55f-4ce9-9f85-d1ffa48a5805","event": "booking_update","url": "https://example.com/webhooks/booking_update"},"booking": {"uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2","testMode": true,"resellerReference": null,"supplierReference": "X749G9","status": "ON_HOLD","utcExpiresAt": "2020-06-07T17:06:37Z","utcConfirmedAt": null,"productId": "1a7213eb-3a33-4cbb-b114-64d771c201ac","optionId": "DEFAULT","cancellable": true,"cancellation": null,"freesale": false,"notes": "optional notes on the booking","availability": {"id": "2020-07-01T14:30:00-05:00","localDateTimeStart": "2020-07-01T14:30:00-05:00","localDateTimeEnd": "2020-07-02T02:30:00-05:00","allDay": true,"openingHours": []},"contact": {"fullName": null,"emailAddress": null,"phoneNumber": null,"locales": [],"country": null},"deliveryMethods": ["VOUCHER","TICKET"],"voucher": {"redemptionMethod": "DIGITAL","utcRedeemedAt": null,"deliveryOptions": []},"unitItems": [{"uuid": "eeddd74e-88e6-4dab-84e9-14f7af18935f","resellerReference": null,"supplierReference": "408H44","unitId": "child","ticket": {"redemptionMethod": "DIGITAL","utcRedeemedAt": null,"deliveryOptions": []}},{"uuid": "ec1e2622-1359-437b-83f8-15182759d605","resellerReference": null,"supplierReference": "BSDYM4","unitId": "adult","ticket": {"redemptionMethod": "DIGITAL","utcRedeemedAt": null,"deliveryOptions": []}},{"uuid": "de9855fd-8176-4551-9ba9-ae8c997cb2bb","resellerReference": null,"supplierReference": "E5K92G","unitId": "adult","ticket": {"redemptionMethod": "DIGITAL","utcRedeemedAt": null,"deliveryOptions": []}}]}}
{"webhook": {"id": "5c7d6dbb-cd4c-48fd-9709-0ebaa14d7a00","event": "availability_update","url": "https://example.com/webhooks/availability_update"},"availability": {"productId": "1a7213eb-3a33-4cbb-b114-64d771c201ac","optionId": "DEFAULT","id": "2020-07-01T11:30:00-05:00","localDateTimeStart": "2020-07-01T11:30:00-05:00","localDateTimeEnd": "2020-07-01T23:30:00-05:00","allDay": false,"status": "AVAILABLE","vacancies": 12,"capacity": 24,"maxUnits": 24,"openingHours": []},}
This endpoint will return a list of all existing webhooks.
getList Webhooks
[{"id": "59a7aca3-e55f-4ce9-9f85-d1ffa48a5805","event": "booking_update","url": "https://example.com/webhooks/booking_update"},{"id": "5c7d6dbb-cd4c-48fd-9709-0ebaa14d7a00","event": "availability_update","url": "https://example.com/webhooks/availability_update"}]
deleteDelete Webhooks
​
