ZenotiHelp

Use webhook event APIs

ZTZenoti Docs Team Updated March 7, 2026 3 min readGuide

Zenoti webhooks deliver real-time event notifications to your application when data changes in the system. This article documents all supported webhook event types and their payload structures. For webhook setup and configuration, see Set up webhook integration.

For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.


On this page


Before you begin

  • You need a webhook subscription configured in Zenoti. See Set up webhook integration.
  • Your destination URL must be publicly accessible and respond within 10 seconds.
  • A subscription to the Zenoti API package is required.

Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.

Event payload structure

All webhook events follow a standard envelope format:

Field Type Description
id string Unique identifier for this webhook delivery
event_id string Unique identifier for the event
event_schema string Schema version (for example, v1)
event_resource string Entity type (for example, Guest, Invoice, Employee)
event_type string Specific event (for example, Guest.Created, Invoice.Closed)
event_timestamp datetime UTC timestamp of the event
data object Event-specific payload

The HTTP header includes a signature for webhook authenticity verification. Webhooks are delivered using POST, PUT, or PATCH methods.

Guest events

Event type Trigger
Guest.Created A new guest is added to the system
Guest.Updated Guest information is changed
Guest.Deleted A guest is removed from the system
Guest.CommunicationOptedIn A guest enables marketing or transactional communications
Guest.CommunicationOptedOut A guest disables marketing or transactional communications

Invoice events

Event type Trigger
Invoice.Closed An invoice is closed and finalized
InvoicePayment.Created A payment is added to an invoice
InvoicePayment.Updated A payment on an invoice is modified

Appointment events

Event type Trigger
Appointment.Started A service appointment begins
Appointment.Completed A service appointment is finished
Feedback.Started Customer feedback collection is initiated
AppointmentGroup.Created Multiple appointments are grouped together
AppointmentGroup.Status The status of an appointment group changes

Employee events

Event type Trigger
Employee.Created A new employee is added
Employee.Updated Employee details are changed
Employee.Deleted An employee is removed

The employee event payload includes personal information (first_name, last_name, email, gender, birth_date), phone numbers, address, job details (job_id, job_name, designation_id, salary, hourly_rate, pay_type), login information, preferences, and catalog settings.

Membership events

Event type Trigger
GuestMembership.Created A new membership is purchased
GuestMembership.Freeze A membership is paused
GuestMembership.Unfreeze A paused membership is resumed
GuestMembership.Cancelled A membership is terminated
GuestMembership.Reinstate A cancelled membership is restored
GuestPass.Redemption A membership pass is used

Class events

Schedule events

Event type Trigger
Schedule.Created A new class schedule is established
Schedule.Updated A class schedule is modified
Schedule.Cancelled A class schedule is cancelled
Schedule.Deleted A class schedule is removed

Booking events

Event type Trigger
Booking.Created A guest books a class
Booking.Deleted A class booking is removed
Booking.Cancelled A guest cancels a class reservation
Booking.NoShow A guest does not attend a booked class
Booking.Approved A class booking is confirmed
Booking.Rejected A class booking is declined

Package events

Event type Trigger
GuestPackage.Creation A package is purchased
GuestPackage.Redemption Package sessions are used
GuestPackage.RedemptionReversal A package redemption is reversed
GuestPackage.StatusUpdate The status of a package changes
GuestPackage.ValidityUpdate The expiration date of a package is modified

Product and inventory events

Event type Trigger
ProductOrder.Created A product order is created
ProductOrder.Updated A product order is modified
InventoryTransfer.Created An inventory transfer is created
PurchaseOrder.Created A purchase order is created
PurchaseOrder.Updated A purchase order is modified

Tips

  • Subscribe only to the events your integration needs. Receiving unnecessary events adds processing overhead.
  • Use the event_type field to route events to the appropriate handler in your application.
  • Implement idempotent processing using the id field to handle potential duplicate deliveries gracefully.
  • Log all received events for debugging and audit purposes.

API reference

Was this article helpful?
Your feedback helps us improve our documentation.