Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Booking Notification Webhook

Developer Preview

Permissions

This webhook requires the Read Bookings - Including Participants permission scope.

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
sendSmsReminder

boolean

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.

previousSession

object

relevant only for OWNER_UPDATED_SESSION

reason

string

Supported values: UNDEFINED, OWNER_BOOKED, VISITOR_BOOKING_REQUEST_CREATED, VISITOR_BOOKING_CONFIRMED, OWNER_CANCELED, OWNER_UPDATED_SESSION, MEMBER_CANCELLED, OWNER_UPDATED_SCHEDULE, OWNER_RESCHEDULED_BOOKING, MEMBER_RESCHEDULED_BOOKING, OWNER_UPDATED_ATTENDANCE, OWNER_CONFIRMED_BOOKING_REQUEST, OWNER_DECLINED_BOOKING_REQUEST.

notifyParticipants
Deprecated

boolean

deprecated, use participant_notification

session

object

relevant only for OWNER_UPDATED_SESSION

previousBooking

object

in case of create this field is empty.

bookedSessionIntervalsChanged

boolean

relevant only on OWNER_UPDATED_SCHEDULE events

participantNotification

object

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

booking

object

Was this helpful?

Member rescheduled booking notification

Member rescheduled a booking.

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 "reason": "MEMBER_RESCHEDULED_BOOKING",
4 "booking": {
5 "id": "316b22d3-8146-4d2e-b5e0-fa3bc00bd6ab",
6 "bookedEntity": {
7 "serviceId": "cd6d46be-f0e6-473a-9f2b-0dba0403f981",
8 "scheduleId": "c9ada746-0981-4b2c-95ec-7c2160cf568a",
9 "singleSession": {
10 "sessionId": "2mmoW0vwKcSFyxtOfCdKMy1Pt4WuAN5dkalqGVfhyadZnqBdh6cq9Ks3m4fXrXOJSE6549NwWCYwpEvOfZbQTXrZN12Zb7txZJoT",
11 "start": "2020-05-30T05:00:00Z",
12 "end": "2020-05-30T06:30:00Z"
13 },
14 "title": "Appointment - Online Payment",
15 "location": {"locationType": "OWNER_BUSINESS"},
16 "rate": {"labeledPriceOptions": {"general": {
17 "amount": "1500",
18 "currency": "JPY",
19 "downPayAmount": "0"
20 }}},
21 "tags": ["INDIVIDUAL"]
22 },
23 "bookedResources": [ {
24 "id": "936d2078-79ba-49ca-b82d-8f12b8a050ac",
25 "name": "Dorgal",
26 "email": "dorga@wix.com"
27 }],
28 "formInfo": {
29 "contactDetails": {
30 "contactId": "d7fa1fb7-85ad-40f2-9b65-e85753324dbe",
31 "firstName": "Homer",
32 "lastName": "Simpson",
33 "email": "Doh@Doh.com",
34 "phone": "5558707",
35 "timeZone": "Asia/Jerusalem",
36 "countryCode": "IL"
37 },
38 "paymentSelection": [ {
39 "rateLabel": "general",
40 "numberOfParticipants": 1
41 }],
42 "additionalFields": [ {
43 "id": "6d6151af-d05f-422d-a738-7c97397e0756",
44 "label": "Add Your Message",
45 "valueType": "LONG_TEXT"
46 }]
47 },
48 "paymentDetails": {
49 "balance": {
50 "finalPrice": {
51 "amount": "1500",
52 "currency": "JPY",
53 "downPayAmount": "0"
54 },
55 "amountReceived": "1500"
56 },
57 "wixPayDetails": {
58 "txId": "7463580b-c74a-4108-8517-682246d3e55c",
59 "orderId": "0cd5873e-f124-40a3-a9c7-f3ea7aeeb75d",
60 "orderAmount": "1500",
61 "orderApprovalTime": "2020-04-30T10:12:46.429Z",
62 "paymentVendorName": "creditCard"
63 },
64 "state": "COMPLETE",
65 "wixPayMultipleDetails": [ {
66 "txId": "7463580b-c74a-4108-8517-682246d3e55c",
67 "orderId": "0cd5873e-f124-40a3-a9c7-f3ea7aeeb75d",
68 "orderAmount": "1500",
69 "orderApprovalTime": "2020-04-30T10:12:46.429Z",
70 "paymentVendorName": "creditCard"
71 }]
72 },
73 "status": "CONFIRMED",
74 "created": "2020-04-30T10:12:18.942Z"
75 },
76 "previousBooking": {
77 "id": "316b22d3-8146-4d2e-b5e0-fa3bc00bd6ab",
78 "bookedEntity": {
79 "serviceId": "cd6d46be-f0e6-473a-9f2b-0dba0403f981",
80 "scheduleId": "c9ada746-0981-4b2c-95ec-7c2160cf568a",
81 "singleSession": {
82 "sessionId": "2mmoW0vwKcSFyxtOfCdKMy1Pt4WuAN5dkalqGVfhyadZnqBdh6cq9Ks3m4fXrXOJSE6549NwWCYwpEvOfZbQTXrZN12Zb7txZJoT",
83 "start": "2020-05-30T10:00:00Z",
84 "end": "2020-05-30T11:30:00Z"
85 },
86 "title": "1時間30分",
87 "location": {"locationType": "OWNER_BUSINESS"},
88 "rate": {"labeledPriceOptions": {"general": {
89 "amount": "1500",
90 "currency": "JPY",
91 "downPayAmount": "0"
92 }}},
93 "tags": ["INDIVIDUAL"]
94 },
95 "bookedResources": [ {
96 "id": "936d2078-79ba-49ca-b82d-8f12b8a050ac",
97 "name": "Dorgal",
98 "email": "dorga@wix.com"
99 }],
100 "formInfo": {
101 "contactDetails": {
102 "contactId": "d7fa1fb7-85ad-40f2-9b65-e85753324dbe",
103 "firstName": "Homer",
104 "lastName": "Simpson",
105 "email": "Doh@Doh.com",
106 "phone": "5558707",
107 "timeZone": "Asia/Jerusalem",
108 "countryCode": "IL"
109 },
110 "paymentSelection": [ {
111 "rateLabel": "general",
112 "numberOfParticipants": 1
113 }],
114 "additionalFields": [ {
115 "id": "6d6151af-d05f-422d-a738-7c97397e0756",
116 "label": "Add Your Message",
117 "valueType": "LONG_TEXT"
118 }]
119 },
120 "paymentDetails": {
121 "balance": {
122 "finalPrice": {
123 "amount": "1500",
124 "currency": "JPY",
125 "downPayAmount": "0"
126 },
127 "amountReceived": "1500"
128 },
129 "wixPayDetails": {
130 "txId": "7463580b-c74a-4108-8517-682246d3e55c",
131 "orderId": "0cd5873e-f124-40a3-a9c7-f3ea7aeeb75d",
132 "orderAmount": "1500",
133 "orderApprovalTime": "2020-04-30T10:12:46.429Z",
134 "paymentVendorName": "creditCard"
135 },
136 "state": "COMPLETE",
137 "wixPayMultipleDetails": [ {
138 "txId": "7463580b-c74a-4108-8517-682246d3e55c",
139 "orderId": "0cd5873e-f124-40a3-a9c7-f3ea7aeeb75d",
140 "orderAmount": "1500",
141 "orderApprovalTime": "2020-04-30T10:12:46.429Z",
142 "paymentVendorName": "creditCard"
143 }]
144 },
145 "status": "CONFIRMED",
146 "created": "2020-04-30T10:12:18.942Z"
147 },
148 "participantNotification": {},
149 "sendSmsReminder": false
150}
Owner booked notification
Visitor booking confirmed notification
Owner updated attendance notification
Owner canceled booking notification