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)

secret

Secret

Creates a new secret.

The `createSecret()` function returns a Promise that resolves secret ID when the secret is created.

>**Notes:**
> - The secret's name cannot start with `'wix'` or be identical to an existing secret's name.
> - Don't leave private keys in your code. Leaving them in your code is a security risk. Make sure to delete the keys from the code after running `createSecret()`.

import { secrets } from '@wix/secrets';

async function createSecret(secret) {
  const response = await secrets.createSecret(secret);
};

createSecret: Wix-hosted

import { createClient } from '@wix/sdk';
import { secrets } from '@wix/secrets';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { secrets },
  // Include the auth strategy and host as relevant
});


async function createSecret(secret) {
  const response = await myWixClient.secrets.createSecret(secret);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

createSecret: Self-hosted

createSecret

Manage Secrets

string

Fulfilled - The ID of the created secret.
Rejected - Error message.

The unique ID of the secret to be deleted.

Deletes an existing secret by ID.

The `deleteSecret()` function returns a Promise that resolves when the secret is deleted. You can retrieve the secret `_id` using the [`listSecretInfo()`](#listsecretinfo) function.

>**Note:**
> Deleting a secret is irreversible and will break all code using the secret.

import { secrets } from '@wix/secrets';

async function deleteSecret(id) {
  const response = await secrets.deleteSecret(id);
};

deleteSecret: Wix-hosted

import { createClient } from '@wix/sdk';
import { secrets } from '@wix/secrets';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { secrets },
  // Include the auth strategy and host as relevant
});


async function deleteSecret(id) {
  const response = await myWixClient.secrets.deleteSecret(id);
};

deleteSecret: Self-hosted

deleteSecret

void

Fulfilled - When the secret is successfully deleted. Rejected - Error message.

The name of the secret to get the value of.

name

Retrieves the secret value specified by the secret name.

The `getSecretValue()` function returns a Promise that resolves to the value of the secret with the specified given name.

>**Note:**
> Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk.

import { secrets } from '@wix/secrets';

async function getSecretValue(name) {
  const response = await secrets.getSecretValue(name);
};

getSecretValue: Wix-hosted

import { createClient } from '@wix/sdk';
import { secrets } from '@wix/secrets';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { secrets },
  // Include the auth strategy and host as relevant
});


async function getSecretValue(name) {
  const response = await myWixClient.secrets.getSecretValue(name);
};

getSecretValue: Self-hosted

getSecretValue

GetSecretValueResponse

Fulfilled - The value of the secret. Rejected - Error message.

Retrieves a list of objects containing information about all secrets.

The `listSecretInfo()` function returns a Promise that resolves to a list containing information about all secrets stored on your site.

> **Note:**
> - The secret's value does not get returned for security reasons. To retrieve a secret's value, use the [`getSecretValue()`](#getSecretValue) function.

import { secrets } from '@wix/secrets';

async function listSecretInfo() {
  const response = await secrets.listSecretInfo();
};

listSecretInfo: Wix-hosted

import { createClient } from '@wix/sdk';
import { secrets } from '@wix/secrets';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { secrets },
  // Include the auth strategy and host as relevant
});


async function listSecretInfo() {
  const response = await myWixClient.secrets.listSecretInfo();
};

listSecretInfo: Self-hosted

listSecretInfo

ListSecretInfoResponse

Fulfilled - A list of objects containing information about your site's secrets. Rejected - Error message.

The unique ID of the secret to be updated.

Updates the specified fields of an existing secret by ID.


The `updateSecret()` function returns a Promise that resolves when the secret is successfully updated. You can update one or more fields. Only fields passed in the `secret` object will be updated. All other properties will remain unchanged.

You can retrieve the `_id` parameter from the [`listSecretInfo()`](#listsecretinfo) function. The secret `_id` is different from the secret `name` used by the [`getSecretValue()`](#getsecretvalue) function.

> **Notes:**
> - Changing a secret's name or value will break all code using the secret.
> - You can't rename the secret with a name of an existing secret.
> - Don't leave private keys in your code! Leaving them in is a security risk. Make sure to delete the keys from the code after running `updateSecret()`.

import { secrets } from '@wix/secrets';

async function updateSecret(id, secret) {
  const response = await secrets.updateSecret(id, secret);
};

updateSecret: Wix-hosted

import { createClient } from '@wix/sdk';
import { secrets } from '@wix/secrets';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { secrets },
  // Include the auth strategy and host as relevant
});


async function updateSecret(id, secret) {
  const response = await myWixClient.secrets.updateSecret(id, secret);
};

updateSecret: Self-hosted

updateSecret

Fulfilled - When the secret is updated.
Rejected - Error message.

To use the Secrets API, install the `@wix/secrets` package using npm or Yarn:
  ```console
npm install @wix/secrets
```

or

```console
yarn add @wix/secrets
```

Then import `{ secrets }` from `@wix/secrets`:

```js
import { secrets } from '@wix/secrets'
```
  

secrets_secrets

EventMetadata

Unique event ID.
Allows clients to ignore duplicate webhooks.

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

eventTime

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

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

boolean

The plaintext, unencrypted value of the secret.

value

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

identityType

WebhookIdentityType

Object containing information for each secret.

secrets

OnSecretCreatedHandler

event

SecretCreatedEnvelope

OnSecretDeletedHandler

SecretDeletedEnvelope

OnSecretUpdatedHandler

SecretUpdatedEnvelope

The date and time the secreted was created.

_createdDate

The date and time the secret was last updated.

_updatedDate

An optional text describing the secret's purpose or any other notes about it.

description

A unique, meaningful name used for retrieving the secret at runtime with the `getSecretValue()` function. You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.

The confidential value to protect, such as an API key.

deleteSecret( )