All Versions

Booking updated

EVENT booking.updated

Published when a booking is updated or cancelled.

To receive this event with buyer-level permissions, you must have APPOINTMENTS_READ set for the OAuth scope.
To receive this event with seller-level permissions, you must have APPOINTMENTS_ALL_READ and APPOINTMENTS_READ set for the OAuth scope.

Permissions

APPOINTMENTS_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the target seller associated with the event.
`type string`	The type of this event. The value is `"booking.updated"`.
`event_id string`	A unique ID for the event.
`created_at string`	Read only The timestamp of when the event was created, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
`data BookingUpdatedSquareEventData`	The data associated with the event.

Examples

All Versions

{
  "merchant_id": "GQQWA3J6A3AEZ",
  "location_id": "L9R0X9X5SGDBJ",
  "type": "booking.updated",
  "event_id": "d954ea4e-a393-52d4-bda6-bfd10cbd571f",
  "created_at": "2020-12-08T20:05:00Z",
  "data": {
    "type": "booking",
    "id": "i2id2g3enyspi7:1",
    "object": {
      "booking": {
        "id": "i2id2g3enyspi7",
        "status": "ACCEPTED",
        "customer_note": "I would like to sit near the window please",
        "seller_note": "",
        "start_at": "2020-12-17T16:00:00Z",
        "created_at": "2020-12-08T19:56:53Z",
        "updated_at": "2020-12-08T20:05:00Z",
        "version": 1,
        "appointment_segments": [
          {
            "service_variation_id": "T3WUWYFJOVW2EU6XGRU5YG4A",
            "duration_minutes": 30,
            "service_variation_version": 1605808735978,
            "team_member_id": "_4GsfYnqGHyurOwzWdKj"
          }
        ],
        "customer_id": "SSKBT02ECWZXK6W3VWYC78E52R",
        "location_id": "L9R0X9X5SGDBJ"
      }
    }
  }
}