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 Secrets API

With the Secrets API you can create and manage secrets such as API keys. The value of each secret is safely stored and encrypted by Wix, so you can securely store API keys and other secrets. Each secret value is encrypted and assigned a name of your choice and an ID. You can then use the name to refer to the secret in your code rather than hardcoding its value.

With the Secrets API, you can safely:

- Create/delete/update a secret.
- Retrieve a value of a secret.
- Retrieve other information about your secrets, such as their names and descriptions.

## Before you begin

It's important to note the following:

- Before you can create or manage secrets with the Secrets API, install the [Wix Members Area](fallback::https://www.wix.com/app-market/web-solution/members-area) app. The Members Area isn't required to retrieve secrets with the [Get Secret Value](fallback::https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value) endpoint.
- Deleting a secret, or modifying a secret's name or value, breaks all code using the secret.
- You can't create or rename a secret with a name that's already in use.
- If you currently use private keys in your code, we recommend removing them and recreating those keys with this API. 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 calling the [Update Secret](fallback::https://dev.wix.com/docs/rest/business-management/secrets/update-secret) endpoint.

## Use Cases

- [Get an API key and use it to fetch information from a weather service](fallback::https://dev.wix.com/docs/rest/business-management/secrets/sample-use-cases-and-flows)

## Terminology

- **Secret**: Secrets are values that you don’t want to be publicly accessible, such as login credentials or API keys.
- **API key**: An API key is a unique code used to authenticate a user or program when making a call to an API. 


# Secrets: Sample Use Cases and Flows

This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.

## Get an API key and use it to fetch information from a weather service

This use case demonstrates how you can store an API key from a weather service (for example, https://openweathermap.org/), and then use it to fetch the weather information to display on your site.    

To get the weather data:

1. Call [Create Secret](fallback::https://dev.wix.com/docs/rest/business-management/secrets/create-secret) to store your API key you received after signing up on the OpenWeather site.
1. Call [Get Secret Value](fallback::https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value), assign the returned value to a variable, and make an OpenWeather API call, for example:

    ```curl
    https://api.openweathermap.org/data/2.5/weather?q=London&units=metric&APPID={WEATHER_KEY}
    ```

1. Extract the required values from the returned JSON object and display them on your site.

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

Int64Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

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

CreateSecretRequest

CreateSecretResponse

DeleteSecretRequest

DeleteSecretResponse

name

GetSecretValueRequest

The plaintext, unencrypted value of the secret.

GetSecretValueResponse

ListSecretInfoRequest

secrets

ListSecretInfoResponse

Date and time when the secret was created.

createdDate

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

description

A unique, human-friendly name for the secret. Use it to retrieve the secret value easily with the [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value) endpoint.

**Note:** You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.

Date and time when the secret was updated.

updatedDate

Secret

UpdateSecretRequest

UpdateSecretResponse

Manage Secrets

GetSecretValue

Retrieves a list of secrets.

>**Note:** This endpoint doesn't return the secret's value for security reasons. To retrieve the value, call [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value).

ListSecretInfo

CreateSecret

Secret Created

DeleteSecret

Secret Deleted

Updates 1 or all fields of a secret.

To get the secret ID, call [List Secret Info](https://dev.wix.com/docs/rest/business-management/secrets/list-secret-info).

Partially Update Secret