About the Form Submission Service Plugin

Important:

When developing websites or building apps with Blocks, use Velo service plugins.

As a form submission provider, you can integrate with Wix to allow Wix users to request and use your services on their Wix sites. By integrating your service with Wix, the service validates and submits a site visitor's form.

The integration is done via an app in the Wix App Market (created in the app dashboard) and by implementing the Form Submission service plugin. After the app is installed on a site, Wix triggers a call to your service whenever a form is submitted on the site.

Learn more about implementing a service plugin with Wix.

Before you begin

It's important to note the following before starting to code:

  • The Form Submission service plugin only works with the Wix Forms app. Call GetAppInstance to confirm that the app named wix_forms is installed on the site.
  • There are several apps that use forms. To validate form submission for a specific Wix app, configure your app in the app dashboard and define the relevant namespace field in the extension. For example, the namespace for the Wix Forms app is "wix.form_app.form".

Use cases

Using the service plugin, you can design your app to validate a form after a site visitor submits it, including:

  • Field validations: Check if the email address is in the correct format or that the name contains only alphabetic characters.
  • Prevent submission of invalid data: Disable the submit button until all fields are correctly filled out.
  • Real-time feedback: Highlight the invalid fields.
  • Prevent duplicate submissions: Check for duplicate submissions based on certain criteria and prevent site visitors from submitting the same form multiple times.

Get started

To enable Wix to communicate with your app:

  1. Go to Extensions in your app's dashboard.
  2. Click Create Extension in the top right corner.
  3. Filter by Wix Forms in the left menu. Then find Form Submission and click Create.
  4. Provide the following configuration:
NameTypeDescription
deploymentUristringRequired. URI which Wix Forms calls to retrieve the validation. The URI consists of base URI and endpoint path.
For example, "deploymentUri": "https://my-validations.com/v4/validateSubmission" where https://my-validations.com/ is a base and v4/validateSubmission is the endpoint path.
namespaceConfigsArray of objectsA collection of Wix apps.
namespaceConfigs.namespacestringThe app which the form submissions belong to:
  • Wix Forms: wix.form_app.form
  • Wix Pricing Plans: wix.pricing_plans.v1.custom_form
  • Wix Online Programs: wix.achievements.quizzes.v1.quiz
formIdstringForm ID which submissions will be validated. This field is optional. If you don't provide the form ID, submissions from all forms in the defined app will be validated.
namespaceConfigs.submissionValidationEnabledbooleanWhether to enable the submission validation in your app.

Terminology

  • Submission: Data received when a site visitor submits a form.
  • Validation: Process that makes sure the information that the site visitor put into a form is correct and meets certain rules.
  • Form: Online interface that allows site visitors to input and submit data.

See also

Did this help?