Event Notification Payload
Payloads describe the data that is delivered to your URL, for each web-hook notification, based on your configuration.
As part of every notification data payload that is sent, whether that is booking data, or customer data, our system will tell you which event triggered the delivery.
{
"eventNotificationCompanyName": "North Shore Adventure Co,.",
"eventNotificationCompanyIdentifier": "4ea3f5td",
"eventNotificationGroupId": 100,
"eventNotificationTypeId": 100,
"eventNotificationId": 32847,
"eventNotificationName": "New Booking Notification",
"eventNotificationDateTime": "2022-08-06T09:31:09.659",
"eventNotificationType": "Booking Creation",
"eventNotificationIpAddress": "127.0.0.1",
"eventNotificationSystem": "northshoreadventureco",
"eventData":{ }
}
Every event payload also contains the event data, such as Booking Data or Customer Data.
Field | Description |
eventNotificationCompanyName | String value describing the name of the company install |
eventNotificationCompanyUniqueIdentifier | Unique ID for the Zaui install |
eventNotificationGroupId | The overall group for which this notification belongs. See the section that describes all possible event groups in the system |
eventNotificationTypeId | The sub type classification within the even group. See the section that describes all possible groups and group types in the system |
eventNotificationId | Contains a unique ID for the event as configured within Zaui |
eventNotificationName | The name of the event as configured with in Zaui |
eventNotificationDateTime | Date and time stamp of when the notification was generated and delivered including micro time |
eventNotificationType | String type of notification |
eventNotificationIpAddress | IP of the system sending the payload |
eventData | Object for the event specific data payload |