These docs are for v1.0.0. Click to read the latest docs for v2.0.0.

Data model description

The event object is sent in the Webhook payload, in standard JSON format and contains a unique ID, the event that triggered the payload (e.g. booking.scheduled), the time the event occurred, the API version, and a nested data object. Learn more about the event object and the Webhook payload

FieldTypeDescription
idstringUnique alphanumeric identifier for the object. The prefix of the event ID is EVNT_.
objectstringString representing the object’s type. Objects of the same type share the same value. The value here is event.
creation_timedatetimeThe time the event object was created.
typestringThe type of the event. See below for the event types we currently support.
api_versionstringThe OnceHub API version used to render the data object.
datahashThe object containing relevant data associated with the event that triggered the payload.