The booking object contains all of the relevant data about the booking. It includes booking data, booking lifecycle status, cancel/reschedule data (when relevant), booking form submission data, booking page, master page, and event type data.

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.

id

string

Unique identifier for the object.

tracking_id

string

A unique ID automatically assigned to every booking.

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

in_trash

boolean

The booking was moved to trash in the activity stream. While this value is true, the activity can still be found in the trash and has not been hard deleted yet.

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.

customer_timezone

string

The timezone selected by the customer when making the booking. Displayed in IANA timezone format.

last_updated_time

datetime

The date and time the booking was last updated.

owner

string, expandable

The ID of 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_conferencing

hash

The object containing information about the video conference in case of virtual meeting.

virtual_conferencing.join_url

string

The URL to join the video conference meeting.

location_description

string

Information about the physical location in case of physical meeting.

rescheduled_booking_id

string

The ID of the booking that was rescheduled.

cancel_reschedule_url

string

URL for cancelling and rescheduling the booking.

  • At the moment, only being sent out in webhooks.

cancel_reschedule_information

hash

An object containing information about the cancel / reschedule event.

cancel_reschedule_information.reason

string

The reason given for canceling or rescheduling a meeting.

cancel_reschedule_information.actioned_by

string

The person who actioned the cancel / reschedule. Valid options are user (person in your team) and customer (person who made the booking).

cancel_reschedule_information.user_id

string

If the cancel reschedule was done by the user, this field will contain their user id.

form_submission

hash

The object containing information entered by the customer into the booking form. This will include any system fields and custom fields defined in your 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

string, expandable

The ID of the booking page used to make the booking.

master_page

string, expandable

The ID of the master booking page used to make the booking.

event_type

string, expandable

The ID of the service selected by customer.

conversation

string, expandable

The ID of the conversation that this booking was scheduled from, null if the booking did not come from a conversation.

external_calendar

hash

Object containing information about the calendar used in the booking.

external_calendar.type

string

Type of calendar, value can be one of google, exchange, office_365, or icloud.

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.

utm_params

hash

Object containing captured values for the 5 standard UTM parameters. Not included in booking webhooks at this time.
* If no UTM params exist on the booking, object will return null

BOOKING

{
  "object": "booking",
  "id": "BKNG-J4FR05BKEWEX",
  "tracking_id": "D36E0002",
  "subject": "Live demo",
  "status": "scheduled",
  "creation_time": "2020-03-22T09:48:48Z",
  "starting_time": "2020-03-22T04:30:00Z",
  "customer_timezone": "America/New_York",
  "last_updated_time": "2020-03-22T09:48:48Z",
  "owner": "USR-FSD423423",
  "duration_minutes": 60,
  "virtual_conferencing": {
    "join_url": "https://meet.google.com/izv-daci-fyi"
  },
  "location_description": "123 Office Street",
  "rescheduled_booking_id": "BKNG-J4FR05BKEWEX",
  "cancel_reschedule_information": {
    "reason": "Change in schedule",
    "actioned_by": "user",
    "user_id": "USR-FSD423423"
  },
  "form_submission": {
    "name": "Carrie Customer",
    "email": "[email protected]",
    "phone": null,
    "mobile_phone": "1-2025550195",
    "note": "I want to discuss whether your product can work for our office.",
    "company": null,
    "guests": [],
    "custom_fields": [
      { "name": "Title", "value": "Executive Assistant" },
      { "name": "Office size", "value": "30-50 people" },
      { "name": "Industry", "value": "Lawnscaping services" }
    ]
  },
  "booking_page": "BP-X0LCRU5LES",
  "master_page": "MP-ZID28U5946",
  "event_type": "ET-7NC41GHIDZ",
  "conversation": "CVR-ZLS0AG3YXZTH",
  "external_calendar": {
    "type": "google",
    "name": "[email protected]",
    "id": "[email protected]",
    "event_id": "8kvu74dda8kcv0gmmlm3folrhc"
  },
  "utm_params": {
    "source": "facebook",
    "medium": "social",
    "campaign": null,
    "term": null,
    "content": null
  }
}