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)

#  About the Async Job API
The Async Job API provides access to asyncronous jobs across Wix's APIs. Use this API to check job status (initialized, processing, etc.) and job item successes and failures.

## Use cases
- [Get job results for Bulk Update Products By Filter call](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::54bd0792-6fd2-4852-b156-ba8f6e2bc4caslug::sample-flows#get-job-results-for-bulk-update-products-by-filter-call*fallback::https://dev.wix.com/docs/rest/business-management/async-job/sample-flows#get-job-results-for-bulk-update-products-by-filter-call).

## Terminology
- **Job**: An async bulk activity executed by Wix's servers. For example, bulk updating products.
- **Job item**: An individual action executed as part of a job. For example, an individual product update.
- **Job status**: Job Status: The current stage or progress of the asynchronous job process. Statuses include:
  - Initialized.
  - Processing.
  - Finished.
  - Failed.


# Sample Flow
This article shares some typical use cases you can support, as well as an example flow that supports each use case. 
You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your implementation.

## Get job results for Bulk Update Products by Filter call

1. Call Wix Stores' [Bulk Update Products by Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products-by-filter) with products to update and collect the `jobId` from the response.
2. Call [Get Async Job](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::54bd0792-6fd2-4852-b156-ba8f6e2bc4caslug::get-async-job*fallback::https://dev.wix.com/docs/rest/business-management/async-job/get-async-job) to get the job status and number of items remain to be processed.
3. Call [List Async Job Items](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::54bd0792-6fd2-4852-b156-ba8f6e2bc4caslug::list-async-job-items*fallback::https://dev.wix.com/docs/rest/business-management/async-job/list-async-job-items) to retrieve the updated product entities.


identityType

IdentificationData

WebhookIdentityType

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

data

eventType

The identification type and identity data.

instanceId

MessageEnvelope

value

BoolValue

paths

FieldMask

Int32Value

Int64Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

code

description

ApplicationError

Pointer to the next or previous page in the list of results.

Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

Maximum number of items to return in the results.

limit

CursorPaging

bodyAsJson

ActionEvent

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z

eventTime

Unique event ID.
Allows clients to ignore duplicate webhooks.

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

DomainEvent

body

entityAsJson

Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity

EntityCreatedEvent

deletedEntityAsJson

EntityDeletedEvent

Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.

currentEntityAsJson

EntityUpdatedEvent

deletedDate

RestoreInfo

Date and time the job was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.

createdDate

status

Date and time the job was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.

updatedDate

AsyncJob

Mapping between an error code and the number of failures associated with it.

errorCountByCode

itemsFailed

Amount of items that were successfully processed.

itemsSucceeded

Optional count of the dataset size, as specified during job creation. Can be used for progress bars, etc.

itemsToProcess

Counters

errorByCodeCount

failCount

successCount

Optional count of the dataset size, specified during job creation. Can be used for progress bars, etc.

total

Counts

type

CreatedBy

Visitor ID - when the job is owned by a site visitor that was **not** logged in.

AnonymousVisitorIdOptions

App ID - when the job is owned by an external application or Wix service.

AppIdOptions

Member ID - when the job is owned by a by a **logged in** site visitor.

MemberIdOptions

Type

User ID - when the job is owned by a site owner or contributor.

WixUserIdOptions

Visitor ID - when the job is created by a site visitor that was **not** logged in.

Get Async Job

Permission Scopes