Zenoti Webhook is a reverse API that notifies your application whenever it finds specific business changes . For instance, events such as creation of a guest, update to a membership, or closing an invoice.
In other words, Webhooks act as a bridge between your application and Zenoti and pass on the necessary information when an event occurs.
Protocol: HTTP
Verbs: POST, PUT, PATCH
Structure of an Event Response Object
Response Objects usually contain the following elements:
Id : Identifies the webhook call
event_id: Identifies the event type
event_schema: Object schema version of the resource of a corresponding event.
event_resource: Name of the event. For example, Guest, Invoice
event_type: Name of the event type. For example, Guest Creation, Invoice Closed, etc
event_timestamp: Time and date when the event was triggered.
data: Response object of the corresponding event.
A sample structure of the Event Response Code:
{
"id": "622b5b33a961750e01db6512",
"event_id": "622b5b33a961750e01db6510",
"event_schema": "v1",
"event_resource": "Invoice",
"event_type": "Invoice.Closed",
"event_timestamp": "2022-03-11T14:22:43.3847049Z",
"data": {}
}
Zenoti Webhooks supports the following event types (Click the links to view the corresponding response codes):
Supported Events
Event Types | Event Names |
Invoice | |
Guest | |
Class | |
Guest Membership | |
Guest Package | |
Appointment | |
Appointment Group | |
Employee |
You must have the necessary role permissions to enable the Webhooks. After you get the necessary role permissions, you can automate tasks for above-mentioned event types.