Search.../

Generate a test token to explore our APIs

Schedule Notification Webhook

Developer Preview

Event 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

NAME

TYPE

DESCRIPTION

instanceId

string

ONE OF:

sessionCancelled

object

sessionCreated

object

availabilityPolicyUpdated

object

intervalSplit

object

scheduleUpdated

object

sessionUpdated

object

scheduleCreated

object

migrationEvent

object

supported only for schedule migration apis.

multipleSessionsCreated

object

supported only for schedule migration apis.

scheduleCancelled

object

preserveFutureSessionsWithParticipants

boolean

notifyParticipants

Deprecated

boolean

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

siteProperties

Deprecated

object

site properties. Optional. Given in create schedule notification.

Was this helpful?

Availability policy updated notification

Availability policy updated.

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

Event Body

json

1{
2  "data": {
3    "eventType": "<event-type>",
4    "instanceId": "<app-instance-id>",
5    "data": "<stringified-JSON>"
6  }
7}

The parsed data will include:

Sample Data

json

1
2{
3  "availabilityPolicyUpdated": {"availabilityPolicy": {"splitInterval":   {
4    "sameAsDuration": false,
5    "valueInMinutes": 30
6  }}},
7  "instanceId": "40be5cd1-bfaf-45f6-9077-b25a711f91dc"
8}

Schedule created notification

Session created notification

Session updaed notification

Session canceled notification

Schedule canceled notification

Schedule updated notification