booking.held

A booking slot was held while payment, review, or another prerequisite is pending.

stablev1bookingsscope: appointments:read

Payload

Webhook deliveries use the common event envelope. The event-specific object is available at data.object.

events/public/payloads/booking.held.v1.schema.jsonevents/public/examples/booking.held.v1.json

data.object fields

Field	Type	Required
`id`	`string \| null`	optional
`object`	`string \| null`	optional
`metadata`	`object \| null`	optional

dynamic data.object fields

Field	Type	Required	Description
`(_id\|^id)$`	`string \| null`	optional
`.*_at$`	`string \| null`	optional	format: date-time

Additional public-safe fields may be present. Internal identifiers and secrets are not part of the public payload contract.

Example

Event body

{
  "api_version": "2026-06-09",
  "created": "2026-06-09T12:00:00Z",
  "data": {
    "object": {
      "event": "booking.held",
      "id": "book_example",
      "metadata": {
        "example": true
      },
      "object": "booking"
    }
  },
  "environment": "test",
  "id": "wevt_Abcdef1234567890Ghijk",
  "livemode": false,
  "object": "event",
  "type": "booking.held"
}

data.object

{
  "event": "booking.held",
  "id": "book_example",
  "metadata": {
    "example": true
  },
  "object": "booking"
}