{
  "address": {
    "address_line_1": "1600 Pennsylvania Ave NW",
    "administrative_district_level_1": "DC",
    "locality": "Washington",
    "postal_code": "20500"
  },
  "all_day": false,
  "appointment_segments": [
    {
      "any_team_member": false,
      "duration_minutes": 30,
      "intermission_minutes": 0,
      "service_variation_client_id": "ZX7D4N2DOGPUGV4XZP7TAGU4",
      "service_variation_id": "T3WUWYFJOVW2EU6XGRU5YG4A",
      "service_variation_version": 1605808735978,
      "team_member_id": "_4GsfYnqGHyurOwzWdKj"
    }
  ],
  "created_at": "2020-12-08T19:56:53Z",
  "creator_details": {
    "creator_type": "TEAM_MEMBER",
    "team_member_id": "TM6aa35Z_aE_yl8n"
  },
  "customer_id": "SSKBT02ECWZXK6W3VWYC78E52R",
  "customer_note": "Please call before arriving",
  "id": "i2id2g3enyspi7",
  "location_id": "L9R0X9X5SGDBJ",
  "location_type": "BUSINESS_LOCATION",
  "seller_note": "Returning customer",
  "source": "FIRST_PARTY_MERCHANT",
  "start_at": "2020-12-17T16:00:00Z",
  "status": "ACCEPTED",
  "transition_time_minutes": 0,
  "updated_at": "2020-12-08T19:56:53Z",
  "version": 0
}

{
  "address": {
    "address_line_1": "First line of the address",
    "administrative_district_level_1": "State or province abbreviation",
    "locality": "City",
    "postal_code": "ZIP or postal code"
  },
  "all_day": "Whether the booking spans the entire day",
  "appointment_segments": {
    "any_team_member": "Whether any available team member can fulfill this segment",
    "duration_minutes": "Duration of the appointment segment in minutes",
    "intermission_minutes": "Minutes of intermission between this segment and the next",
    "service_variation_client_id": "Client-provided ID for the service variation",
    "service_variation_id": "ID of the catalog item variation representing the service",
    "service_variation_version": "Version of the catalog item variation at the time of booking",
    "team_member_id": "ID of the team member booked for this segment"
  },
  "created_at": "When the booking was created",
  "creator_details": {
    "creator_type": "Type of entity that created the booking (e.g. TEAM_MEMBER, CUSTOMER)",
    "team_member_id": "ID of the team member who created the booking, if applicable"
  },
  "customer_id": "ID of the customer who made the booking",
  "customer_note": "Free-text note from the customer",
  "id": "Unique identifier for the booking",
  "location_id": "ID of the location where the service is provided",
  "location_type": "Type of location for the booking (e.g. BUSINESS_LOCATION, CUSTOMER_LOCATION)",
  "seller_note": "Free-text note from the seller (not visible to customers)",
  "source": "Source that created the booking (e.g. FIRST_PARTY_MERCHANT, FIRST_PARTY_BUYER)",
  "start_at": "Start time of the booking",
  "status": "Status of the booking (e.g. ACCEPTED, CANCELLED_BY_CUSTOMER)",
  "transition_time_minutes": "Buffer time in minutes before the next booking",
  "updated_at": "When the booking was last updated",
  "version": "Revision number for optimistic concurrency control"
}

Events

Triggering Webhook Types

The following event types are associated with the Booking event payload from Square.

Square Booking Created
Square Booking Updated

{
  "address": {
    "address_line_1": "1600 Pennsylvania Ave NW",
    "administrative_district_level_1": "DC",
    "locality": "Washington",
    "postal_code": "20500"
  },
  "all_day": false,
  "appointment_segments": [
    {
      "any_team_member": false,
      "duration_minutes": 30,
      "intermission_minutes": 0,
      "service_variation_client_id": "ZX7D4N2DOGPUGV4XZP7TAGU4",
      "service_variation_id": "T3WUWYFJOVW2EU6XGRU5YG4A",
      "service_variation_version": 1605808735978,
      "team_member_id": "_4GsfYnqGHyurOwzWdKj"
    }
  ],
  "created_at": "2020-12-08T19:56:53Z",
  "creator_details": {
    "creator_type": "TEAM_MEMBER",
    "team_member_id": "TM6aa35Z_aE_yl8n"
  },
  "customer_id": "SSKBT02ECWZXK6W3VWYC78E52R",
  "customer_note": "Please call before arriving",
  "id": "i2id2g3enyspi7",
  "location_id": "L9R0X9X5SGDBJ",
  "location_type": "BUSINESS_LOCATION",
  "seller_note": "Returning customer",
  "source": "FIRST_PARTY_MERCHANT",
  "start_at": "2020-12-17T16:00:00Z",
  "status": "ACCEPTED",
  "transition_time_minutes": 0,
  "updated_at": "2020-12-08T19:56:53Z",
  "version": 0
}

{
  "address": {
    "address_line_1": "First line of the address",
    "administrative_district_level_1": "State or province abbreviation",
    "locality": "City",
    "postal_code": "ZIP or postal code"
  },
  "all_day": "Whether the booking spans the entire day",
  "appointment_segments": {
    "any_team_member": "Whether any available team member can fulfill this segment",
    "duration_minutes": "Duration of the appointment segment in minutes",
    "intermission_minutes": "Minutes of intermission between this segment and the next",
    "service_variation_client_id": "Client-provided ID for the service variation",
    "service_variation_id": "ID of the catalog item variation representing the service",
    "service_variation_version": "Version of the catalog item variation at the time of booking",
    "team_member_id": "ID of the team member booked for this segment"
  },
  "created_at": "When the booking was created",
  "creator_details": {
    "creator_type": "Type of entity that created the booking (e.g. TEAM_MEMBER, CUSTOMER)",
    "team_member_id": "ID of the team member who created the booking, if applicable"
  },
  "customer_id": "ID of the customer who made the booking",
  "customer_note": "Free-text note from the customer",
  "id": "Unique identifier for the booking",
  "location_id": "ID of the location where the service is provided",
  "location_type": "Type of location for the booking (e.g. BUSINESS_LOCATION, CUSTOMER_LOCATION)",
  "seller_note": "Free-text note from the seller (not visible to customers)",
  "source": "Source that created the booking (e.g. FIRST_PARTY_MERCHANT, FIRST_PARTY_BUYER)",
  "start_at": "Start time of the booking",
  "status": "Status of the booking (e.g. ACCEPTED, CANCELLED_BY_CUSTOMER)",
  "transition_time_minutes": "Buffer time in minutes before the next booking",
  "updated_at": "When the booking was last updated",
  "version": "Revision number for optimistic concurrency control"
}

Payload Field Details

Event Payload

Hide fields

string

required

Unique identifier for the booking

CEL

id

Example

"i2id2g3enyspi7"

string

required

Status of the booking (e.g. ACCEPTED, CANCELLED_BY_CUSTOMER)

CEL

status

Example

"ACCEPTED"

string

ID of the customer who made the booking

CEL

customer_id

Example

"SSKBT02ECWZXK6W3VWYC78E52R"

string

Free-text note from the customer

CEL

customer_note

Example

"Please call before arriving"

string

Free-text note from the seller (not visible to customers)

CEL

seller_note

Example

"Returning customer"

string

ID of the location where the service is provided

CEL

location_id

Example

"L9R0X9X5SGDBJ"

timing.v1.Timestamp

Start time of the booking

CEL

start_at

Example

"2020-12-17T16:00:00Z"

timing.v1.Timestamp

required

When the booking was created

CEL

created_at

Example

"2020-12-08T19:56:53Z"

timing.v1.Timestamp

required

When the booking was last updated

CEL

updated_at

Example

"2020-12-08T19:56:53Z"

int64

required

Revision number for optimistic concurrency control

CEL

version

Example

[]object

required

List of appointment segments for this booking

CEL

appointment_segments

Example

[
{
"any_team_member": false,
"duration_minutes": 30,
"intermission_minutes": 0,
"service_variation_client_id": "ZX7D4N2DOGPUGV4XZP7TAGU4",
"service_variation_id": "T3WUWYFJOVW2EU6XGRU5YG4A",
"service_variation_version": 1605808735978,
"team_member_id": "_4GsfYnqGHyurOwzWdKj"
}
]

[]string

required

Mapped array of: ID of the catalog item variation representing the service

CEL

appointment_segments.map(x, x.service_variation_id)

Example

[
"T3WUWYFJOVW2EU6XGRU5YG4A"
]

[]string

required

Mapped array of: ID of the team member booked for this segment

CEL

appointment_segments.map(x, x.team_member_id)

Example

[
"_4GsfYnqGHyurOwzWdKj"
]

[]int64

required

Mapped array of: Duration of the appointment segment in minutes

CEL

appointment_segments.map(x, x.duration_minutes)

Example

[
30
]

[]int64

required

Mapped array of: Version of the catalog item variation at the time of booking

CEL

appointment_segments.map(x, x.service_variation_version)

Example

[
1605808735978
]

[]bool

required

Mapped array of: Whether any available team member can fulfill this segment

CEL

appointment_segments.map(x, x.any_team_member)

Example

[
false
]

[]int64

required

Mapped array of: Minutes of intermission between this segment and the next

CEL

appointment_segments.map(x, x.intermission_minutes)

Example

[
0
]

[]string

required

Mapped array of: Client-provided ID for the service variation

CEL

appointment_segments.map(x, x.service_variation_client_id)

Example

[
"ZX7D4N2DOGPUGV4XZP7TAGU4"
]

object

Address of the booking location

CEL

address

Example

{
"address_line_1": "1600 Pennsylvania Ave NW",
"administrative_district_level_1": "DC",
"locality": "Washington",
"postal_code": "20500"
}

string

First line of the address

CEL

address.address_line_1

Example

"1600 Pennsylvania Ave NW"

string

State or province abbreviation

CEL

address.administrative_district_level_1

Example

"DC"

string

City

CEL

address.locality

Example

"Washington"

string

ZIP or postal code

CEL

address.postal_code

Example

"20500"

bool

Whether the booking spans the entire day

CEL

all_day

Example

false

object

Details about who created the booking

CEL

creator_details

Example

{
"creator_type": "TEAM_MEMBER",
"team_member_id": "TM6aa35Z_aE_yl8n"
}

string

Type of entity that created the booking (e.g. TEAM_MEMBER, CUSTOMER)

CEL

creator_details.creator_type

Example

"TEAM_MEMBER"

string

ID of the team member who created the booking, if applicable

CEL

creator_details.team_member_id

Example

"TM6aa35Z_aE_yl8n"

string

Type of location for the booking (e.g. BUSINESS_LOCATION, CUSTOMER_LOCATION)

CEL

location_type

Example

"BUSINESS_LOCATION"

string

Source that created the booking (e.g. FIRST_PARTY_MERCHANT, FIRST_PARTY_BUYER)

CEL

source

Example

"FIRST_PARTY_MERCHANT"

int64

Buffer time in minutes before the next booking

CEL

transition_time_minutes

Example

⌘I

​Events

​Triggering Webhook Types

​Payload Field Details

Events

Triggering Webhook Types

Payload Field Details