The booking object

Data model description

The booking object is sent in standard JSON format inside the data object, which is nested under the event object in the Webhook payload. The booking object contains a tracking ID, booking data, cancel/reschedule data when relevant, Booking form submission data, Booking page, Master page, and event type data. Learn more about the data object and the Webhook payload

Field	Type	Description
`object`	string	String representing the object’s type. Objects of the same type share the same value. The type here is `booking`.
`tracking_id`	string	A unique ID automatically assigned to every booking.
`package_id`	string	A unique ID automatically assigned to every Session package.
`subject`	string	The name of the Service or Subject as defined in the Booking form.
`status`	string	The status of the booking event. The booking can have any of the following statuses: Requested, Scheduled, Rescheduled, Completed, Canceled, or No-Show.
`creation_time`	datetime	The date and time when the booking was created.
`starting_time`	datetime	The date and time when the meeting is scheduled to start.
`owner`	string	The owner of the booking. This is the User who originally accepted the booking, and remains unchanged even if the booking was reassigned to a new Booking page.
`duration_minutes`	integer	The length of the meeting, in minutes.
`virtual_or_physical_location`	string	The virtual or physical location for the meeting.
`customer_time_zone_description`	string	The time zone selected by the Customer.
`cancel_reschedule_link`	url	The Cancel/Reschedule link sent to the Customer.
`canceled_booking_tracking_id`	string	The tracking ID of the booking that was canceled.
`cancel_reschedule_reason`	string	The reason given for canceling or rescheduling a meeting.
`name_of_user_who_canceled_rescheduled`	string	The name of the User who performed the cancellation or reschedule action.
`name_of_customer_who_canceled_rescheduled`	string	The name of the Customer who performed the cancellation or reschedule action.
`form_submission`	hash	The object containing information entered by the Customer into the Booking form.
`form_submission.name`	string	The name provided by the Customer in the Booking form.
`form_submission.email`	string	The email provided by the Customer in the Booking form.
`form_submission.phone`	string	The phone number provided by the Customer in the Booking form.
`form_submission.mobile_phone`	string	The mobile phone number provided by the Customer in the Booking form.
`form_submission.note`	string	The note provided by the Customer in the Booking form.
`form_submission.company`	string	The company provided by your Customer in the Booking form.
`form_submission.guests`	array	List of additional attendees (emails) invited by the Customer.
`form_submission.custom_fields`	hash	The object containing custom Booking form fields.
`booking_page.public_name`	string	The Customer-facing name of the Booking page used to make the booking.
`booking_page.internal_label`	string	The internal name of the Booking page used to make the booking.
`booking_page.link`	url	The URL of the Booking page used to make the booking.
`booking_page.category`	string	The Category to which the Booking page has been assigned.
`booking_page.time_zone_description`	string	The time zone of the Booking page as defined in the Availability section.
`master_page.name`	string	The Customer-facing name of the Master booking page used to make the booking.
`master_page.label`	string	The internal name of the Master booking page used to make the booking. The label is defined in the left pane of the Master booking pages tab under Configuration.
`master_page.link`	url	The URL of the Master booking page used to make the booking.
`event_type.name`	string	The name of the Service selected by the Customer.
`event_type.description`	string	The description of the Service selected by the Customer.
`event_type.category`	string	The Category of the Service selected by the Customer.
`external_calendar.type`	string	The type of external calendar to which the booking was added.
`external_calendar.name`	string	The name of the external calendar to which the booking was added.
`external_calendar.id`	string	The id of the external calendar to which the booking was added.
`external_calendar.event_id`	string	The id of the booking event that was created in the external calendar.