Schedule 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 schedule changes.

Deprecation Notice:

This event has been replaced with events belonging to the Calendar V3 APIs and will be removed on June 30, 2025.

Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Including Participants
Read bookings calendar - including participants
Learn more about app permissions.
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
preserveFutureSessionsWithParticipantsboolean
notifyParticipantsbooleandeprecated

Whether to notify participants about changed sessions. deprecated, use participant_notification

sitePropertiesSiteProperties

site properties. Optional. Given in create schedule notification.

instanceIdstring
ONE OF:
scheduleCreatedScheduleCreated
scheduleUpdatedScheduleUpdated
scheduleCancelledScheduleCancelled
sessionCreatedSessionCreated
sessionUpdatedSessionUpdated
sessionCancelledSessionCancelled
availabilityPolicyUpdatedAvailabilityPolicyUpdated
intervalSplitIntervalSplitdeprecated
recurringSessionSplitRecurringSessionSplit
scheduleUnassignedFromUserScheduleUnassignedFromUserdeprecated

Inspect schedule.scheduleOwnerUserId on scheduleUpdated instead.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{
  "data": {
    "eventType": "com.wix.bookings.schedules.api.v1.ScheduleNotification",
    "instanceId": "<app-instance-id>",
    "data": "<stringified-JSON>",
    // The identity field is sent as a stringified JSON
    "identity": {
      "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
      "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
      "memberId": "<memberId>", // in case of MEMBER
      "wixUserId": "<wixUserId>", // in case of WIX_USER
      "appId": "<appId>" // in case of APP
    }
  }
}
Did this help?