Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

Information about the created submission and metadata for the event.

event

SubmissionCreated

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixForms_onSubmissionCreated(event) {
  const entityId = event.entity._id;
  console.log(`Created submission with the id: ${entityId}. Event details: `, event)
}

/* Full event object:
{
    "entity": {
        "formId": "21bcb6c7-02b3-4ed1-b6db-7856094fac03",
        "namespace": "wix.form_app.form",
        "status": "PENDING",
        "submissions": {
            "first_name": "Patsy",
            "last_name": "McBride"
        },
        "revision": "1",
        "owner": {
            "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
        },
        "submitter": {
            "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
        },
        "seen": false,
        "_id": "f8281b62-1b2f-45bf-ba7d-f041d7653d2d",
        "_createdDate": "2023-12-28T12:55:55.630Z",
        "_updatedDate": "2023-12-28T12:55:55.746Z"
    },
    "metadata": {
       "entityId": "f8281b62-1b2f-45bf-ba7d-f041d7653d2d",
       "eventTime": "2023-12-28T12:55:55.630Z",
       "id": "a92d9e8b-abd7-4903-a954-5a6848f6f4eb",
        "triggeredByAnonymizeRequest": false
    }
}


An event that triggers when submission is created 

onSubmissionCreated

void

Information about the submission that was deleted.

SubmissionDeleted

> **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](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named `wix_forms` is installed on the site.
 
Triggered when a submission is deleted.

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixForms_onSubmissionDeleted(event) {
  console.log(`Deleted submission. Event details: `, event)
}

/* Full event object:
{
    "metadata": {
       "entityId": "f8281b62-1b2f-45bf-ba7d-f041d7653d2d",
       "eventTime": "2023-12-28T12:55:55.630Z",
       "id": "a92d9e8b-abd7-4903-a954-5a6848f6f4eb",
        "triggeredByAnonymizeRequest": false
    }
}

An event that triggers when a submission is deleted 

onSubmissionDeleted

Information about the updated submission and metadata for the event.

SubmissionUpdated

Triggered when:
- Submission is updated.
- Submission order status is updated.
- Submission is confirmed.

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixForms_onSubmissionUpdated(event) {
  const entityId = event.entity._id;
  console.log(`Updated submission with the id: ${entityId}. Event details: `, event)
}

/* Full event object:
{
    "entity": {
        "formId": "21bcb6c7-02b3-4ed1-b6db-7856094fac03",
        "namespace": "wix.form_app.form",
        "status": "PENDING",
        "submissions": {
            "first_name": "Patsy",
            "last_name": "McBride"
        },
        "revision": "1",
        "owner": {
            "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
        },
        "submitter": {
            "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
        },
        "seen": false,
        "_id": "f8281b62-1b2f-45bf-ba7d-f041d7653d2d",
        "_createdDate": "2023-12-28T12:55:55.630Z",
        "_updatedDate": "2023-12-29T11:53:55.746Z"
    },
    "metadata": {
       "entityId": "f8281b62-1b2f-45bf-ba7d-f041d7653d2d",
       "eventTime": "2023-12-29T11:53:55.746Z",
       "id": "a92d9e8b-abd7-4903-a954-5a6848f6f4eb",
        "triggeredByAnonymizeRequest": false
    }
}


An event that triggers when submission is updated 

onSubmissionUpdated

---
title: Introduction
---

# Introduction

Wix Forms events are fired in your site's backend when certain events related to forms occur in your site's backend. You can write event handlers that react to these events. Event handler functions receive data that corresponds to the event that has occurred. Use event handlers to create custom responses to forms events.

> **Note:** Backend events don't work when previewing your site.

To add a forms event handler, add an **events.js** file to the **Backend** section of your site if one does not already exist. All event handler functions for your
site are defined in this file.

Event handler functions are defined using the following pattern:
```javascript
export function <wixAppName>_<eventName>(event) { }
```

For example, an event handler that handles form submission updates looks like this:
```javascript
export function wixForms_onSubmissionUpdated(event) { }
```

velo-events_wix-forms.v2

BackendEventMetadata

ID of the entity associated with the event.

entityId

string

eventTime

Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.

triggeredByAnonymizeRequest

boolean

ExtendedFields

Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
The value of each key is structured according to the schema defined when the extended fields were configured.

You can only access fields for which you have the appropriate permissions.

Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).

namespaces

FormSpamSubmissionReport

Date of submission creation. If a submission was created in the past, pass the original submission creation date.

_createdDate

_updatedDate

extendedFields

Id of a form to which the form spam submission report belongs.

formId

Form namespace to which the form spam submission report belongs.

namespace

orderDetails

OrderDetails

Identifies the reason why the submission was reported as spam.

reportReason

ReportReason

Date of form spam submission report creation.

reportedDate

Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.

revision

Last status of the submission at the time of the report

submissionStatusAtReport

SubmissionStatus

Submission values where key is a target of a form field and value is a submissions for the given field.

submissions

submitter

Submitter

FormSpamSubmissionReportCreated

entity

metadata

FormSpamSubmissionReportDeleted

ID of the checkout related to submission (applicable if form has payments added).

checkoutId

applicationId

memberId

userId

visitorId

SpamSubmission

Id of a form to which submission belongs.

Form namespace to which submissions belong.

SpamSubmissionCreated

SpamSubmissionDeleted

SpamSubmissionUpdated

FormSubmission

Date and time the form submission was created.

Date and time the form submission was updated.

Data extension object that holds users' and apps' fields.

ID of the form which the submission belongs to.

The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `Get Submission` to retrieve the namespace.

Order details. 
Note: This object is only applicable when submittng a form in the Wix Payments app.

Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.

Whether a site owner marked a submission as "seen".

seen

Status of the submission.
- `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.

status

Submission values where `key` is the form field and `value` is the data submitted for the given field.

ID of the visitor that submitted the form.

FormSubmissionStatusUpdatedEvent

previousStatus

submission

MarketingSubscriptionDetails

emails

Subscription consent opt in level, either single or double confirmation.
Default: SINGLE_CONFIRMATION

optInLevel

MarketingSubscriptionDetailsOptInLevel

submittedDate

ID of the checkout related to submission (only applicable if a form has payments).

onSubmissionCreated( )