About Form Submissions

With Wix Form Submissions, site owners can manage individual form submissions from site visitors.

The Form Submissions API provides flexibility in managing form submission data and allows your app to:

• Query and manage submissions for a specified form.
• Retrieve the total number of submissions per form.
• Support the ability to upload media files to a media manager folder when forms include "file upload" fields.

Learn more about Wix Forms.

Before you begin

• The Form Submission API is only available in Wix Studio and Editor X.
• The Form Submission API only works with the Wix Forms app. Call GetAppInstance to confirm that the app named wix_forms is installed on the site.

Use cases

• Submit a form with media
• Periodically sync with an external analysis and reporting tool
• Sync with an external CRM for marketing purposes

Terminology

• Submission: Data received when a site visitor submits a form.
• Media Upload URL: A URL used to upload a file to a form.
• Namespace: The app that a form belongs to.

Form Submissions: Sample Use Cases and Flows

This article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.

Submit a form with media

You can upload media files to a media manager folder by creating a new submission for a form that contains a field for uploading files.

1. Call Get Media Upload URL to generate the upload URL for the specified file.

2. Call Create Submission and use the generated URL as the value for the file upload field.

Periodically sync with an external analysis and reporting tool

You can retrieve submission data and upload it to an external data analysis tool. With the external tool, site owners can easily do a statistical analysis of their form submission data.

1. For the first load, use Query Submissions By Namespace and filter for all submissions whose status has been confirmed.

2. Extract any desired data from the submissions payload, then upload the data to your app.

3. For all subsequent loads, use the Query Submissions By Namespace endpoint and filter for submissions that are confirmed and have not yet been seen.

4. Repeat step 2 to 3 for each subsequent load.

Sync with an external CRM for marketing purposes

Every time a form gets submitted, you can add the form submitter to an external CRM. A site owner can then use their CRM to send marketing emails to their form submitters. This flow relies on forms that requires a submitters email, and on an external CRM service.

1. When the Submission Created Webhook is triggered, you'll receive the submission in the payload from createdEvent.entity.

2. Exract the email address from the submissions object.

3. Check that the email adress is not already listed as a subscriber in the external CRM.

4. Upload the new subscriber to the CRM.

Form Submissions: Supported Filters and Sorting

The following table shows field support for filters and sorting for the form submission object:

Field	Supported Filters	Sortable
id	$eq, $ne, $in, $nin	Sortable
createdDate	$eq, $gt, $gte, $in, $lt, $lte, $ne, $nin	Sortable
updatedDate	$eq, $gt, $gte, $in, $lt, $lte, $ne, $nin	Sortable
formId	$eq, $ne, $in, $nin	Sortable
namespace	$eq, $ne, $in, $nin	Sortable
properties	$eq, $ne	Sortable
status	$eq, $ne, $in, $nin	Sortable

Related content: API Query Language, Query Submissions