Webhooks
Get notifications sent to you when something changes
This capability allows you to create webhooks which will notify a given URL whenever an action happens in Peek Pro, e.g. Booking Update or Booking Cancellation.
Create Webhook
POST
https://octo.peek.com/integrations/octo/webhooks
Create a new webhook
Request Body
url*
String
The URL to call when the webhook is triggered
event*
String
The event that will trigger the webhook
Field
Description
url
A fully formed URL. If you want to include basic authentication credentials that is supported also. For example:
https://user:pass@example.com/webook
https://example.com/webhook
event
The event that will trigger the webhook. Possible values are:
booking_update
triggered when an existing booking is confirmed, updated or cancelled.
An example response will look like this:
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:
This endpoint will return a list of all existing webhooks.
List Webhooks
GET
https://octo.peek.com/integrations/octo/webhooks
List all webhooks
Delete Webhooks
DELETE
https://octo.peek.com/integrations/octo/webhooks/:id
Delete an existing webhook
Path Parameters
id*
String
The webhook id
Last updated