Webhooks
Webhooks allow our booking systems to automatically send real-time updates to other platforms whenever something important happens. They act like push notifications for data ensuring our customers stay fully aligned with the latest booking information.
Webhook Topics
What are Webhooks
Webhooks allow for real time data to be sent from Events to our customers. Giving live data in regards to bookings that are created / edited / cancelled. Opening up many opportunities for marketing and other purposes.
Why Use Them
Webhooks make integrations faster, more efficient, and more accurate. By sending updates the moment a booking changes, other systems such as CRMs will always have the most current information. This reduces operational overhead, avoids stale data, and helps partners build automations or workflows around live booking activity.
Setup
When creating Zonal enable this feature we can configure the following information:
-
Authentication types:
-
JWT
-
HMAC - recommended
-
-
Additional settings regarding what is included in the webhook and what types of booking will trigger a webhook to send:
-
PII - This setting determines whether PII data is included in the webhook payload
-
Enquiries - This setting determines if we will send a webhook for enquiries
-
No Shows - This setting determines if we will send a webhook for no shows
-
Data in Our Webhooks
| Field Name | Example | Description |
|---|---|---|
| Estateid | 3ece8a1f-3756-4824-80dc-660211ca7b3c | Unique identifier for Estate |
| EstateName | Zonal | Name of Estate |
| CompanyID | 3ece8a1f-3756-4824-80dc-660211ca7b3c | Unique identifier for Company |
| CompanyName | Bookings | Name of Company |
| SiteID | 60e1493b-a590-491a-9ca6-32860c930faf | Unique identifier for Estate |
| SiteName | Events | Name of Site |
| EventID | 7c5e1c6c-7765-429b-a00d-ce0160482f1c | Unique identifier for Estate |
| AreaID | 8372bcd1-a424-4ff1-bc41-ed54a439c1b1 | Unique identifier for Estate |
| AreasName | Bar Area | Name of Area |
| BookingReference | ABC1234356 | Unique reference for booking |
| BookingStatus | Confirmed / Provisional / Enquiry | Status of Booking |
| EnquiryStatus | New / Lost / Rejected | Status of Enquiry |
| CancellationReason | Could not attend | Reason booking / enquiry cancelled |
| CustomerForename | John | Name on booking |
| CustomerSurname | Smith | Surname / Last name |
| CustomerPhoneNumber | 077777777 | Telephone Number |
| CustomerEmail | John.smith@zonal.com | Email address |
| BookingDate | 2025-01-25 (YYYY-MM-DD) | Date of Booking |
| BookingTime | 12:00 (HH:mm) | Time of Booking |
| AdultCovers | 2 | Number of Adults |
| ChildCovers | 0 | Number of Children |
| BookingDuration | 90 | Turn time in minutes |
| EventPlanName | Christmas Party | Name given to booking by guest |
| DietaryInformation | Y/N | Dietary info for the Booking |
| DepositDueDate | 2025-01-25 (YYYY-MM-DD) | Date of Deposit Due |
| DespositAmount | 25 | Value required |
| AztecBookingID | 586524525 | Unique identifier for Aztec link |
| OccasionName | Festive | Name of Occasion |
| OccasionID | 6e0a1937-9e22-451a-ace6-6f3ddccb6da4 | Unique identifier for Estate |
| MenuName | Christmas Menu | Name of Menu |
| MenuID | 80468962-24b9-4e01-8b9f-35bd6c8abfb3 | Unique identifier for Estate |
| SMSConsent | Y/N | Consent |
| SMSConsentDateTime | 2025-01-25-12:00 (YYYY-MM-DD-HH:mm) | Date and time |
| SMSConsentChannel | Online | Channel through which consent was given |
| SMSConsentText | Please tick here to consent to marketing | Consent text that was displayed at time of booking |
| EmailConsent | Y/N | Consent |
| EmailConsentDateTime | 2025-01-25-12:00 (YYYY-MM-DD-HH:mm) | Date and time |
| EmailConsentChannel | Online | Channel through which consent was given |
| EmailConsentText | Please tick here to consent to marketing | Consent text that was displayed at time of booking |
| ProfilingConsent | Y/N | Consent |
| ProfilingConsentDateTime | 2025-01-25-12:00 (YYYY-MM-DD-HH:mm) | Date and time |
| ProfilingConsentChannel | Online | Channel through which consent was given |
| ProfilingConsentText | Please tick here to consent to marketing | Consent text that was displayed at time of booking |
| PushConsent | Y/N | Consent |
| PushConsentDateTime | 2025-01-25-12:00 (YYYY-MM-DD-HH:mm) | Date and time |
| PushConsentChannel | Online | Channel through which consent was given |
| PushConsentText | Please tick here to consent to marketing | Consent text that was displayed at time of booking |
| PostalConsent | Y/N | Consent |
| PostalConsentDateTime | 2025-01-25-12:00 (YYYY-MM-DD-HH:mm) | Date and time |
| PostalConsentChannel | Online | Channel through which consent was given |
| PostalConsentText | Please tick here to consent to marketing | Consent text that was displayed at time of booking |
| PhoneConsent | Y/N | Consent |
| PhoneConsentDateTime | 2025-01-25-12:00 (YYYY-MM-DD-HH:mm) | Date and time |
| PhoneConsentChannel | Online | Channel through which consent was given |
| PhoneConsentText | Please tick here to consent to marketing | Consent text that was displayed at time of booking |
| PrivacyConsentDateTime | 2025-01-25-12:00 (YYYY-MM-DD-HH:mm) | Date and time |
| PrivacyConsentChannel | Online | Channel through which consent was given |
| PrivacyConsentText | Please tick here to consent to agree to our Privacy Statement | Privacy text that was displayed at time of booking |
| PrivacyConsentURL | www.zonal.co.uk | Privacy URL that was linked at the time of booking |
| StatementConsentDateTime | 2025-01-25-12:00 (YYYY-MM-DD-HH:mm) | Date and time |
| StatementConsentChannel | Online | Channel through which consent was given |
| StatementConsentText | Please tick here to consent to agree to our Statement | Privacy text that was displayed at time of booking |