Skip to content
/
Delete the webhook for a...

Register to Webhook Events API (1.1.0)

The Webhook APIs is a REST API designed to manage webhooks for booking notifications. It allows partners to register, update, and delete webhook endpoints, enabling them to receive real-time booking event updates.

Download OpenAPI description
WebhookApi.json
WebhookApi.yaml
Overview
URL
https://www.bookabletech.com
Bookable
hello@bookabletech.com
Languages
Servers
Staging
https://api-staging.bookabletech.com/
Production
https://api.bookabletech.com/

webhook

Operations related to webhook management

Operations

Register a webhook endpoint for booking notifications

Request

Security
Staging or Production
Bodyapplication/jsonrequired

Webhook registration request

callbackUrlstring(uri)required

HTTPS URL to be called when a booking event occurs

Example: "https://partner.example.com/webhooks/bookings"
curl -i -X POST \
  https://api-staging.bookabletech.com/webhooks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "callbackUrl": "https://partner.example.com/webhooks/bookings"
  }'

Responses

Webhook successfully registered

Bodyapplication/json
secretKeystring

Unique secret key for the registered webhook to verify data

Example: "123e4567-e89b-12d3-a456-426655440000"
callbackUrlstring(uri)

HTTPS URL to be called when a booking event occurs

Example: "https://partner.example.com/webhooks/bookings"
Response
application/json
{
  "secretKey": "123e4567-e89b-12d3-a456-426655440000",
  "callbackUrl": "https://partner.example.com/webhooks/bookings"
}

Update the webhook callback URL of the specific distributor logged

Request

Security
Staging or Production
Bodyapplication/jsonrequired

Webhook update request. Only the callbackUrl can be modified.

callbackUrlstring(uri)required

HTTPS URL to be called when a booking event occurs

Example: "https://partner.example.com/webhooks/bookings"
curl -i -X PUT \
  https://api-staging.bookabletech.com/webhooks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "callbackUrl": "https://partner.example.com/webhooks/bookings"
  }'

Responses

Webhook successfully updated

Response
No content

Delete the webhook for a specific distributor

Request

Security
Staging or Production
curl -i -X DELETE \
  https://api-staging.bookabletech.com/webhooks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Webhook successfully deleted

Response
No content

Trigger a test webhook event

Request

Sends a test webhook notification to the registered callback URL. This endpoint is useful for testing webhook integration and verifying that the partner's endpoint can receive and process webhook events correctly.

Security
Staging or Production
curl -i -X POST \
  https://api-staging.bookabletech.com/webhooks/test \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Test webhook event accepted and queued for delivery

Bodyapplication/json
messagestring

Confirmation message

Example: "Test webhook event has been queued for delivery"
eventIdstring

Unique identifier for the test event

Example: "evt_test_123e4567"
Response
application/json
{
  "message": "Test webhook event has been queued for delivery",
  "eventId": "evt_test_123e4567"
}