Webhook API specification for receiving booking change notifications from The Bookings Group system. Distributors must implement this endpoint to receive real-time notifications about booking updates.
Handling Webhook Events API (1.2.0)
Download OpenAPI description
Overview
Languages
Servers
Distributor webhook endpoint
https://your-distributor-domain.com/
- Distributor webhook endpointhttps://your-distributor-domain.com
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://your-distributor-domain.com/ \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"eventType": "booking.updated",
"timestamp": "2019-08-24T14:15:22Z",
"bookings": [
{
"id": "29|X9|275cc44dd2e2496fba44857c9257443a|B",
"compositeId": "29|X9|275cc44dd2e2496fba44857c9257443a|d99128c546b34b619c4477b712869f2b",
"date": "2025-06-25",
"time": "19:30:00",
"partySize": 4,
"status": "pending",
"reference": "REF-20250617-001",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"phone": "+1234567890",
"company": "Acme Corp",
"location": {
"address": "123 Main Street",
"city": "New York",
"state": "NY",
"country": "US",
"postalCode": "10001"
},
"duration": 120,
"productType": "dinner",
"notes": "Window table preferred",
"source": "MyDistributor",
"createdDate": "2025-06-17T09:15:00Z",
"lastUpdate": "2025-06-17T10:30:00Z",
"preorders": [
{
"packageId": "string",
"name": "*Pan roasted Padron peppers (V)",
"description": "5 items per guest: Salmon & celeriac on rye, Buttermilk fries chicken...",
"type": "food",
"quantity": 0,
"price": 5.57
}
],
"preorderMenus": [
{
"menuId": "string"
}
]
}
]
}'