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

Resource Notification Webhook

Developer Preview

Permissions

This webhook requires the Read Bookings Calendar or 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
resource

object

Updated resource entity.

event

string

Supported values: UNDEFINED, Updated, Deleted, Created.

Event type.

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 "resource": {
4 "id": "8dfbe020-6fba-4235-9ad4-26dd25e0429b",
5 "name": "John F. Kennedy",
6 "email": "jfk@mysite.info",
7 "phone": "620-428-1751",
8 "tags": ["staff"],
9 "schedules": [ {
10 "id": "04967186-8ac6-414a-92da-310356faebed",
11 "scheduleOwnerId": "8dfbe020-6fba-4235-9ad4-26dd25e0429b",
12 "firstSessionStart": "2020-04-19T13:00:00Z",
13 "timeZone": "Asia/Jerusalem",
14 "intervals": [
15 {
16 "id": "8ecc3fad-2d00-4f53-97e0-84ed1f1fc7a1",
17 "start": "2020-04-18T21:00:00Z",
18 "interval": {
19 "daysOfWeek": "FRI",
20 "hourOfDay": 10,
21 "minuteOfHour": 0,
22 "duration": 480
23 },
24 "frequency": {"repetition": 1}
25 },
26 {
27 "id": "e5744b3c-2b36-4e39-817e-acb9a34a2274",
28 "start": "2020-04-18T21:00:00Z",
29 "interval": {
30 "daysOfWeek": "SAT",
31 "hourOfDay": 9,
32 "minuteOfHour": 0,
33 "duration": 540
34 },
35 "frequency": {"repetition": 1}
36 },
37 {
38 "id": "692f3b56-e460-49f8-9cfc-fbbc8a94a4cc",
39 "start": "2020-04-18T21:00:00Z",
40 "interval": {
41 "daysOfWeek": "SUN",
42 "hourOfDay": 9,
43 "minuteOfHour": 0,
44 "duration": 540
45 },
46 "frequency": {"repetition": 1}
47 }
48 ],
49 "availability": {"start": "2020-04-18T21:00:00Z"},
50 "status": "CREATED",
51 "created": "2020-04-27T20:28:51.846Z",
52 "updated": "2020-04-27T20:28:51.846Z"
53 }],
54 "status": "CREATED"
55 },
56 "event": "Updated"
57}