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.
-
Call Get Media Upload URL to generate the upload URL for the specified file.
-
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.
-
For the first load, use Query Submissions By Namespace and filter for all submissions whose status has been confirmed.
-
Extract any desired data from the
submissions
payload, then upload the data to your app. -
For all subsequent loads, use the Query Submissions By Namespace endpoint and filter for submissions that are confirmed and have not yet been seen.
-
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.
-
When the Submission Created Webhook is triggered, you'll receive the submission in the payload from
createdEvent.entity
. -
Exract the email address from the
submissions
object. -
Check that the email adress is not already listed as a subscriber in the external CRM.
-
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
Form submission that was created or retrieved.
- PENDING: A submission is created, but has not yet been recorded in the Wix Forms collection.
- PAYMENT_WAITING: A form submission requiring payment is created.
- PAYMENT_CANCELED: An order of a form submission is canceled.
- CONFIRMED: A submission is recorded in the Wix Forms collection.
Note: This object is only applicable when submittng a form in the Wix Payments app.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Creates a new submission.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Retrieves a submission by ID.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Deletes a submission by ID.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Updates a submission.
Each time the submission is updated, revision
increments by 1. The existing revision
must be included when updating the submission. This ensures you're working with the latest submission information, and prevents unintended overwrites.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Confirms a submission.
You can only confirm a submission that has a PENDING
status. When using forms from the Wix Pricing Plans app, the default submission status is PENDING
. When using forms from the Wix Forms app, the default form submission status is CONFIRMED
. You can change the default status for individual submissions using the Update Submission endpoint.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.
You can only query submissions from a specified namespace. Use the query filter on the namespace
field, otherwise you will receive an error.
For field support for filters and sorting, see Form Submissions: Supported Filters and Sorting.option
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Counts the number of submissions belonging to the specified forms.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Retrieves a URL, generated by Media Manager, to allow clients to upload a file to a form for submission.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Marks form submissions as "seen".
This endpoint marks the submissions as if they were seen by the site owner. Only site collaborators with the Manage Submission permissions can mark submissions.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a submission is restored.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Triggered when:
- Submission is updated.
- Submission order status is updated.
- Submission is confirmed.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Notes:
- 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.
Triggered when a submission is deleted.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.