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)

jobId

string

import { asyncJobs } from '@wix/async-jobs';

async function getAsyncJob(jobId) {
  const response = await asyncJobs.getAsyncJob(jobId);
};

getAsyncJob: Wix-hosted

// Import the client, the auth strategy for the relevant identity, and the relevant host module

import { asyncJobs } from '@wix/async-jobs';

// const wixClient = Create a client with the relevant module, auth strategy, and host module;

async function getAsyncJob(jobId) {
  const response = await wixClient.asyncJobs.getAsyncJob(jobId);
};

Learn more about [identities](https://dev.wix.com/docs/sdk/articles/getting-started/about-identities) and [host modules](https://dev.wix.com/docs/sdk/host-modules/about-host-modules).

getAsyncJob: Self hosted

getAsyncJob

AsyncJob

options

ListAsyncJobItemsOptions

import { asyncJobs } from '@wix/async-jobs';

async function listAsyncJobItems(jobId, options) {
  const response = await asyncJobs.listAsyncJobItems(jobId, options);
};

listAsyncJobItems: Wix-hosted

// Import the client, the auth strategy for the relevant identity, and the relevant host module

import { asyncJobs } from '@wix/async-jobs';

// const wixClient = Create a client with the relevant module, auth strategy, and host module;

async function listAsyncJobItems(jobId, options) {
  const response = await wixClient.asyncJobs.listAsyncJobItems(jobId, options);
};

listAsyncJobItems: Self hosted

listAsyncJobItems

ListAsyncJobItemsResponse

# About the Async Jobs API

The Async Jobs 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.

## 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.


To use the AsyncJobs API, install the `@wix/async-jobs` package using npm or Yarn:
  ```console
npm install @wix/async-jobs
```

or

```console
yarn add @wix/async-jobs
```

Then import `{ asyncJobs }` from `@wix/async-jobs`:

```js
import { asyncJobs } from '@wix/async-jobs'
```
  

async-jobs_async-jobs

AnonymousVisitorIdOptions

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

anonymousVisitorId

AppIdOptions

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

appId

ApplicationError

code

data

description

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

_createdDate

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

counters

Counters

counts

Counts

createdBy

CreatedBy

Optional job metadata, used to store any parameters used during job execution, user-defined statuses, etc.

metadata

owner

Owner

status

Status

AsyncJobItem

Job item data, as passed by the originating service.

ID of the entity being processed, as passed by the originating service.

entityId

Error that prevented the item from being processed, if relevant.

error

Whether the job item was processed successfully.

success

boolean

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

errorCountByCode

itemsFailed

number

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

errorByCodeCount

failCount

successCount

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

total

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

anonymousVisitorIdOptions

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

appIdOptions

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

memberIdOptions

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

wixUserIdOptions

type

Type

CursorPaging

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

Cursors

Cursor pointing to next page in the list of results.

paging

statusFilter

StatusFilter

pagingMetadata

PagingMetadataV2

results

MemberIdOptions

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

memberId

serviceId

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

wixUserId

Number of items returned in the response.

count

Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.

Setup