Booking Notification

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a booking is created or changed. For exmaple, when it is confirmed, declined, rescheduled, or canceled.

Deprecation Notice:

This webhook has been replaced with the following webhooks in Bookings V2:

The webhook will be removed on December 31, 2024.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.

Event Data

reasonstring

16 enum supported values:

UNDEFINEDOWNER_BOOKEDVISITOR_BOOKING_REQUEST_CREATEDVISITOR_BOOKING_CONFIRMEDOWNER_CANCELEDOWNER_UPDATED_SESSIONMEMBER_CANCELLEDOWNER_UPDATED_SCHEDULEOWNER_RESCHEDULED_BOOKINGMEMBER_RESCHEDULED_BOOKINGOWNER_UPDATED_ATTENDANCEOWNER_CONFIRMED_BOOKING_REQUESTOWNER_DECLINED_BOOKING_REQUESTOWNER_CANCELLED_SESSION_IN_SETOWNER_SET_AS_PAIDVISITOR_BOOKING_DECLINED

bookingobject

notifyParticipantsbooleandeprecated

deprecated, use participant_notification

previousBookingobject

in case of create this field is empty.

participantNotificationobject

Whether to notify participants about the change and an optional custom message

bookedSessionIntervalsChangedboolean

relevant only on OWNER_UPDATED_SCHEDULE events

sessionobject

relevant only for OWNER_UPDATED_SESSION and OWNER_CANCELLED_SESSION_IN_SET

previousSessionobject

relevant only for OWNER_UPDATED_SESSION

sendSmsReminderboolean

When value is set to True, an SMS reminder would be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.

Was this helpful?

Yes