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

Marketing

APIs
  • Wix Forms

    Wix forms allows site owners to easily create custom forms on their websites and get submissions from their visitors

Wix Forms

Wix forms allows site owners to easily create custom forms on their websites and get submissions from their visitors

Webhooks
  • Form Submitted (Lead Generated)

    This webhook is triggered whenever a site visitor fills out a Wix form on your user's site (Note that there are several other form apps/options available ...

Form Submitted (Lead Generated)

This webhook is triggered whenever a site visitor fills out a Wix form on your user's site (Note that there are several other form apps/options available for user sites, but they will not trigger this webhook)

Authorization

This API requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

The API requires CRM.MANAGE_LEADS

Event Body

The event's data is received as a JSON Web Token (JWT). Make sure to verify that the data was received by Wix - read more about it in the Webhooks article.

Payload

NAME
TYPE
DESCRIPTION
formName

string

Name of submitted form

submissionTime

string

Time the form was submitted

submissionData

Array<object>

Data submitted in the form

contactId

string

Contact ID

attachments

Array<object>

File(s) submitted in the form

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 "data": {
4 "data": {
5 "contactId": "6232fddc-9b3f-48c0-a921-dc0f158451d3",
6 "formName": "Contacts Form",
7 "submissionTime": "2019-10-30T10:09:55.667Z",
8 "submissionData": [
9 {
10 "fieldName": "First Name",
11 "fieldValue": "John"
12 },
13 {
14 "fieldName": "Last Name",
15 "fieldValue": "Doe"
16 },
17 {
18 "fieldName": "Email",
19 "fieldValue": "JohnD@example.com"
20 },
21 {
22 "fieldName": "Phone",
23 "fieldValue": "346456456"
24 },
25 {
26 "fieldName": "Message",
27 "fieldValue": "dfgdfgdfgdf"
28 }
29 ]
30 },
31 "instanceId": "dfecbee2-8721-4199-8d51-9b317c61023a",
32 "eventType": "com.wixpress.formbuilder.api.v1.FormSubmittedEvent"
33 },
34 "iat": 1572430195,
35 "exp": 1576030195
36}
)}