🪝Webhooks

Webhooks provide a powerful way to receive real-time notifications of events in your system.

NOTE: V3 is currently in the beta phase and is subject to change.

Overview

When certain events occur, our API will send an HTTP POST request to the specified URL, delivering a payload with event details. This enables you to automate reactions or synchronize data without the need for polling.

Events

Here are the currently supported events you can subscribe to:

• Status changes in a booking

Subscribe to a webhook

POST/api/v3/webhook/subscribe

Header parameters

Body

application/json

callback_url*string

The URL to send the webhook to

event_type*string

The event type to subscribe to

Response

201

Request

JavaScriptCurl

const response = await fetch('/api/v3/webhook/subscribe', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "callback_url": "https://example.com/webhook",
      "event_type": "STATUS"
    }),
});
const data = await response.json();

Unsubscribe from a webhook

DELETE/api/v3/webhook/unsubscribe/{id}

Path parameters

id*string

Header parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v3/webhook/unsubscribe/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Subscribe to a webhook

POST/api/v3/webhook/subscribe

Header parameters

Body

application/json

callback_url*string

The URL to send the webhook to

event_type*string

The event type to subscribe to

Response

201

Request

JavaScriptCurl

const response = await fetch('/api/v3/webhook/subscribe', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "callback_url": "https://example.com/webhook",
      "event_type": "STATUS"
    }),
});
const data = await response.json();