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

Form 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
form

object

event

string

Supported values: Updated, Deleted, Created.

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{"form": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "header": {
5 "description": "Tell us a bit about yourself",
6 "title": "Add Your Info"
7 },
8 "actionLabels": {
9 "offlinePaymentLabel": "Book It",
10 "onlinePaymentLabel": "Pay Now",
11 "bookingRequestApprovalLabel": "Request To Book"
12 },
13 "name": {
14 "fieldId": "00000000-0000-0000-0000-000000000001",
15 "label": "Name",
16 "userConstraints": {"required": true}
17 },
18 "email": {
19 "fieldId": "00000000-0000-0000-0000-000000000002",
20 "label": "Email",
21 "userConstraints": {"required": true}
22 },
23 "phone": {
24 "fieldId": "00000000-0000-0000-0000-000000000003",
25 "label": "Phone Number",
26 "userConstraints": {}
27 },
28 "numberOfParticipants": {
29 "fieldId": "00000000-0000-0000-0000-000000000007",
30 "label": "Number of Participants",
31 "userConstraints": {"required": true}
32 },
33 "address": {
34 "street": {
35 "fieldId": "00000000-0000-0000-0000-000000000004",
36 "label": "Street",
37 "userConstraints": {"required": true}
38 },
39 "city": {
40 "fieldId": "00000000-0000-0000-0000-000000000005",
41 "label": "City",
42 "userConstraints": {"required": true}
43 },
44 "floorNumber": {
45 "fieldId": "00000000-0000-0000-0000-000000000006",
46 "label": "Apt. / Floor No.",
47 "userConstraints": {}
48 },
49 "state": {
50 "fieldId": "00000000-0000-0000-0000-000000000009",
51 "label": "State",
52 "userConstraints": {}
53 }
54 },
55 "customFields": [
56 {
57 "fieldId": "5688a46e-aa0b-424d-b929-810f0cce25e2",
58 "valueType": "LONG_TEXT",
59 "label": "Add Your Message",
60 "userConstraints": {}
61 },
62 {
63 "fieldId": "87e8c627-aae8-433f-8afa-3d1bb0484b72",
64 "label": "Age",
65 "userConstraints": {"required": true}
66 }
67 ]
68}}