Webhook Reservation Canceled

When a reservation is cancelled, BodySpec sends a POST request with this payload to your registered webhook URL. The canceled_by field identifies who initiated the cancellation.

postWebhookreservation_canceled

Payload

event_type'reservation_canceled' required

Type of event (always 'reservation_canceled' for this payload)

event_idstring required

Unique identifier for this event

partner_idstring required

Partner ID this event is for

Example payload

{
  "data": {
    "appt_id": "e8c91d4a2b7f3e6c8d0a5b9f1c3e7d2a",
    "cancel_time": "2024-03-18T09:12:44-07:00",
    "canceled_by": "partner",
    "service_id": "8d0e0a1f561f4ec69dbca50ea14336d",
    "start_time": "2024-03-20T14:00:00-07:00",
    "user_id": "a5950beea2a7487fb79cfdbeb77fa555"
  },
  "event_id": "3b7d2e91c4a85f60b2d9e8a1f7c4b3d6",
  "event_type": "reservation_canceled",
  "partner_id": "pk_acme"
}

Response

Successful Response

unknown required

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.