Event Notification Object

Describes Events and Event Objects

Events

Events are our way of letting you know when something interesting happens in your Zaui account. When an interesting event occurs we create a new Event Object, and send to your configured endpoints.

Event Objects

The Event Object describes the data that is delivered to your endpoint, for each web-hook notification, based on your configuration.

Event objects describe elements about the event which may be useful for your particular endpoint app. The Event object elements are standardized and part of every event that is triggered on your

As part of every Event object that is sent, whether that is booking data, or customer data, our system will tell you which event triggered the delivery.

{
    "eventNotificationUniqueId": "evt_dd07616694d6ecd2d9f8cad0b2ec9ffef304c1ee",
    "eventNotificationCompanyName": "North Shore Adventure Co.",
    "eventNotificationUniqueIdentifier": "b6589fc6ab",
    "eventNotificationGroupId": 400,
    "eventNotificationTypeId": 400,
    "eventNotificationType": "Contact Creation",
    "eventNotificationTypeV2": "contact.creation",
    "eventNotificationDateTime": "2024-04-29T12:00:14-07:00",
    "eventNotificationName": "HR Notification when a new Contact is created",
    "eventNotificationSystem": "northshoreadventureco",
    "eventNotificationSystemUrl": "https://northshoreadventureco.zaui.net/",
    "eventMarketplaceData":{},
    "eventData":{}
}

Every event payload also contains the event data, such as Booking Data or Customer Data.

Field	Type	Description
eventNotificationUniqueId	string	Unique identifier for the object
eventNotificationCompanyName	string	String value describing the name of the company install
eventNotificationUniqueIdentifier	string	Unique ID for the Zaui install
eventNotificationGroupId	int	The overall group for which this notification belongs. See the section that describes all possible event groups in the system
eventNotificationTypeId	int	The sub type classification within the even group. See the section that describes all possible groups and group types in the system
eventNotificationName	string	The name of the event as configured with in Zaui
eventNotificationDateTime	string	ISo-8601 Date and time with timezone
eventNotificationType	string	String type of notification
eventNotificationTypeV2	string	Notification Type (format: category.action)
eventNotificationSystem	string	The Zaui system in which the webhook was set up on and is being triggered from
eventNotificationSystemUrl	string	The url of the Zaui system in which the webhook was set up on and is being triggered from
eventMarketplaceData	object	Object containing any Marketplace data associated with the event
eventData	object	Object containing data associated with the event