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

Service Notification Webhook

Developer Preview

Permissions

This webhook requires the Read Bookings - Public Data 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
service

object

Updated service entity.

event

string

Supported values: Unspecified, Updated, Deleted, Created.

policy

object

Was this helpful?

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 "service": {
4 "id": "f1f3bb0f-10e3-42e8-8c36-a45143199a2a",
5 "info": {
6 "name": "FoxFit Master",
7 "description": "Describe your service here. What makes it great? Use short catchy text to tell people what you offer, and the benefits they will receive. A great description gets readers in the mood, and makes them more likely to go ahead and book.",
8 "images": [ {
9 "id": "375882_f5667b10b81e4213b6d2854f8020e188~mv2.png",
10 "url": "375882_f5667b10b81e4213b6d2854f8020e188~mv2.png",
11 "height": 672,
12 "width": 1008
13 }],
14 "tagLine": ""
15 },
16 "policy": {
17 "maxParticipantsPerBooking": 1,
18 "bookUpToXMinutesBefore": 1440,
19 "cancelRescheduleUpToXMinutesBefore": 180,
20 "isBookOnlineAllowed": true,
21 "isCancelAllowed": true,
22 "isRescheduleAllowed": true,
23 "futureBookingsPolicy": {
24 "shouldLimit": true,
25 "limitXMinutesToTheFuture": 12120
26 },
27 "waitingListPolicy": {
28 "isEnabled": true,
29 "capacity": 55,
30 "timeWindowMinutes": 360
31 }
32 },
33 "paymentOptions": {
34 "wixPayOnline": false,
35 "wixPayInPerson": true,
36 "custom": false,
37 "wixPaidPlan": false
38 },
39 "categoryId": "c9c8091c-7749-47dc-bd61-2f25c004e666",
40 "bookingFormId": "00000000-0000-0000-0000-000000000000",
41 "scheduleIds": ["3b07159b-b02f-442f-970c-17bd2cd14643"],
42 "customProperties": {
43 "order": "2",
44 "uouHidden": "false"
45 },
46 "sortOrder": 2
47 },
48 "event": "Updated"
49}