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)

Activates a loyalty program.

The `activateLoyaltyProgram()` function returns a Promise that resolves when the status of the loyalty program is successfully changed to `"ACTIVE"`.

Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.

This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](wix-loyalty-v2/programs/updateloyaltyprogram) function.

To temporarily pause your loyalty program you must follow three steps:
1. Remove all [`earnPoints()`](wix-loyalty-v2/accounts/earnpoints) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
1. Hide the loyalty page from your site.
1. Delete the My Rewards page from the Member pages.
See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.

>**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can activate a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function activateLoyaltyProgram() {
  const response = await wixClient.programs.activateLoyaltyProgram();
}

activateLoyaltyProgram() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function activateLoyaltyProgram() {
  const response = await wixClient.programs.activateLoyaltyProgram();
}

activateLoyaltyProgram() with Dashboard app access

activateLoyaltyProgram

ActivateLoyaltyProgramResponse

Updates the `pointsExpiration` status to `DISABLED`.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function disablePointsExpiration() {
  const response = await wixClient.programs.disablePointsExpiration();
}

disablePointsExpiration() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function disablePointsExpiration() {
  const response = await wixClient.programs.disablePointsExpiration();
}

disablePointsExpiration() with Dashboard app access

disablePointsExpiration

DisablePointsExpirationResponse

Updates the `pointsExpiration` status to `ENABLED`.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function enablePointsExpiration() {
  const response = await wixClient.programs.enablePointsExpiration();
}

enablePointsExpiration() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function enablePointsExpiration() {
  const response = await wixClient.programs.enablePointsExpiration();
}

enablePointsExpiration() with Dashboard app access

enablePointsExpiration

EnablePointsExpirationResponse

Retrieves the site's loyalty program.

The `getLoyaltyProgram()` function returns a Promise that resolves to the site's loyalty program.

import { createClient, OAuthStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function getLoyaltyProgram() {
  const response = await wixClient.programs.getLoyaltyProgram();
}

getLoyaltyProgram() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getLoyaltyProgram() {
  const response = await wixClient.programs.getLoyaltyProgram();
}

getLoyaltyProgram() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getLoyaltyProgram() {
  const response = await wixClient.programs.getLoyaltyProgram();
}

getLoyaltyProgram() with Dashboard app access

getLoyaltyProgram

GetLoyaltyProgramResponse

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function pauseLoyaltyProgram() {
  const response = await wixClient.programs.pauseLoyaltyProgram();
}

pauseLoyaltyProgram() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function pauseLoyaltyProgram() {
  const response = await wixClient.programs.pauseLoyaltyProgram();
}

pauseLoyaltyProgram() with Dashboard app access

pauseLoyaltyProgram

PauseLoyaltyProgramResponse

loyaltyProgram

LoyaltyProgram

Updates the site's loyalty program.

The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.

With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](wix-loyalty-v2/programs/activateloyaltyprogram) function.

>**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateLoyaltyProgram(loyaltyProgram) {
  const response = await wixClient.programs.updateLoyaltyProgram(loyaltyProgram);
}

updateLoyaltyProgram() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  modules: { programs },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function updateLoyaltyProgram(loyaltyProgram) {
  const response = await wixClient.programs.updateLoyaltyProgram(loyaltyProgram);
}

updateLoyaltyProgram() with Dashboard app access

updateLoyaltyProgram

UpdateLoyaltyProgramResponse

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

or

```console
yarn add @wix/loyalty
```

Then import `{ programs }` from `@wix/loyalty`:

```js
import { programs } from '@wix/loyalty'
```
  

loyalty_programs

Loyalty program with disabled points expiration feature.

Loyalty program with enabled points expiration feature.

EventMetadata

Unique event ID.
Allows clients to ignore duplicate webhooks.

string

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

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

_createdDate

_updatedDate

name

Information about the program's collectible entity.

pointDefinition

PointDefinition

pointsExpiration

PointsExpiration

Information about available premium features

premiumFeatures

PremiumFeatures

Program status. Customers can only earn or redeem points while the program is `ACTIVE`.

Default: `"DRAFT"`

status

ProgramStatus

OnProgramUpdatedHandler

event

ProgramUpdatedEnvelope

void

Display name for the program's collectible unit.

It's recommended to use a plural, for example `Stars`.

In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.

Default: `Points`.

Max: `20` characters.

customName

Image URL. See [Image]($w/image/introduction) for more information on URL formats for images.

icon

expiringPointsPercentage

number

Expire points after set months of inactivity

monthsOfInactivity

Status

Set to true if user has loyalty program premium feature

Set to true if user has points expiration premium feature

Set to true if user has tiers premium feature

tiers

entity

metadata

handler

Triggered when a loyalty program is updated.

import { createClient, AppStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      programs,
    },
});

wixClient.programs.onProgramUpdated((event) => {
    // handle your event here
});

getLoyaltyProgram( )