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 the referral program, changing its status to `ACTIVE`.

import { programs } from '@wix/referral';

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

activateReferralProgram: Wix-hosted

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

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


async function activateReferralProgram() {
  const response = await myWixClient.programs.activateReferralProgram();
};

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

activateReferralProgram: Self-hosted

activateReferralProgram

ActivateReferralProgramResponse

options

GenerateAiSocialMediaPostsSuggestionsOptions

Creates new AI-generated social media post suggestions for promoting the referral program.

This method generates new AI-powered social media post suggestions for promoting the referral program. Use it to refresh content or create alternatives to existing suggestions.

>**Note**: This method generates new suggestions each time it's called. To retrieve existing suggestions without generating new ones, use the [Get AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-ai-social-media-posts-suggestions) method.

import { programs } from '@wix/referral';

async function generateAiSocialMediaPostsSuggestions(options) {
  const response = await programs.generateAiSocialMediaPostsSuggestions(options);
};

generateAiSocialMediaPostsSuggestions: Wix-hosted

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

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


async function generateAiSocialMediaPostsSuggestions(options) {
  const response = await myWixClient.programs.generateAiSocialMediaPostsSuggestions(options);
};

generateAiSocialMediaPostsSuggestions: Self-hosted

generateAiSocialMediaPostsSuggestions

GenerateAISocialMediaPostsSuggestionsResponse

GetAiSocialMediaPostsSuggestionsOptions

Retrieves pre-generated AI social media post suggestions for promoting the referral program.

This method returns a list of AI-generated social media post suggestions that site owners or members can use to promote the referral program. You can display these suggestions in your app's UI, allowing users to easily copy and share them on their preferred social media platforms.

>**Note**: This method retrieves existing suggestions. To generate new ones,
use the [Generate AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/generate-ai-social-media-posts-suggestions) method.

import { programs } from '@wix/referral';

async function getAiSocialMediaPostsSuggestions(options) {
  const response = await programs.getAiSocialMediaPostsSuggestions(options);
};

getAiSocialMediaPostsSuggestions: Wix-hosted

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

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


async function getAiSocialMediaPostsSuggestions(options) {
  const response = await myWixClient.programs.getAiSocialMediaPostsSuggestions(options);
};

getAiSocialMediaPostsSuggestions: Self-hosted

getAiSocialMediaPostsSuggestions

GetAISocialMediaPostsSuggestionsResponse

import { programs } from '@wix/referral';

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

getReferralProgram: Wix-hosted

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

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


async function getReferralProgram() {
  const response = await myWixClient.programs.getReferralProgram();
};

getReferralProgram: Self-hosted

getReferralProgram

GetReferralProgramResponse

Retrieves information about the enabled premium features for the referral program.

import { programs } from '@wix/referral';

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

getReferralProgramPremiumFeatures: Wix-hosted

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

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


async function getReferralProgramPremiumFeatures() {
  const response = await myWixClient.programs.getReferralProgramPremiumFeatures();
};

getReferralProgramPremiumFeatures: Self-hosted

getReferralProgramPremiumFeatures

GetReferralProgramPremiumFeaturesResponse

Pauses the referral program, changing its status to `PAUSED`.

import { programs } from '@wix/referral';

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

pauseReferralProgram: Wix-hosted

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

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


async function pauseReferralProgram() {
  const response = await myWixClient.programs.pauseReferralProgram();
};

pauseReferralProgram: Self-hosted

pauseReferralProgram

PauseReferralProgramResponse

Referral program to update. Include the latest `revision` for a successful update.

referralProgram

ReferralProgram

Updates a referral program. Supports partial updates.

Revision number, which increments by 1 each time the referral program is updated.
To prevent conflicting changes, the current revision must be passed when updating the referral program.

import { programs } from '@wix/referral';

async function updateReferralProgram(referralProgram) {
  const response = await programs.updateReferralProgram(referralProgram);
};

updateReferralProgram: Wix-hosted

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

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


async function updateReferralProgram(referralProgram) {
  const response = await myWixClient.programs.updateReferralProgram(referralProgram);
};

updateReferralProgram: Self-hosted

updateReferralProgram

UpdateReferralProgramResponse

# Introduction

The Referral Program API allows you to create and manage referral program on your Wix site. With this API, you can incentivize your existing customers to bring in new ones, helping you grow your business through word-of-mouth marketing.

With the Referral Program API, you can:

+ [Activate your referral program](https://dev.wix.com/docs/sdk/backend-modules/marketing/referral-program/program/activate-referral-program).
+ [Generate AI-powered social media post suggestions](https://dev.wix.com/docs/sdk/backend-modules/marketing/referral-program/program/generate-ai-social-media-posts-suggestions).
+ [Retrieve AI-generated social media post suggestions](https://dev.wix.com/docs/sdk/backend-modules/marketing/referral-program/program/get-ai-social-media-posts-suggestions).
+ [Get details of your current referral program](https://dev.wix.com/docs/sdk/backend-modules/marketing/referral-program/program/get-referral-program).
+ [Check available premium features](https://dev.wix.com/docs/sdk/backend-modules/marketing/referral-program/program/get-referral-program-premium-features).
+ [Pause your referral program](https://dev.wix.com/docs/sdk/backend-modules/marketing/referral-program/program/pause-referral-program).
+ [Update your referral program](https://dev.wix.com/docs/sdk/backend-modules/marketing/referral-program/program/update-referral-program).

See the [Wix Referral Program: Adding and Setting Up Your Referral Program](https://support.wix.com/en/article/wix-referral-program-adding-and-setting-up-your-referral-program) article for more information on setting up and managing referral program on your Wix site.

## Before you begin

It's important to note the following points before starting to code:

- The Referral Program API requires a Business or higher plan for Wix Editor, or a Plus or higher plan for Wix Studio.
- You must have at least one of these apps installed: Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans, or the new Wix Restaurants Ordering app.

## Terminology

- **Referral program**: A system that allows site members to refer friends to your business by sharing referral URLs.
- **Referring customer**: An existing customer who refers a friend to the business.
- **Referred friend**: A new customer who was referred to the business by an existing customer.
- **Reward**: An incentive given to both the referring customer and the referred friend for participating in the program.
- **Successful referral action**: An action taken by the referred friend that triggers a reward for the referring customer. For example, placing an order, booking a session.
- **Referral URL**: A unique link generated for each site member that can be shared with potential new customers The member copies and shares this link with potential customers. When clicked, it brings the referred friend to the site, where they can sign up and redeem their reward.


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

or

```console
yarn add @wix/referral
```

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

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

referral_programs

AISocialMediaPostSuggestion

hashtags

postContent

string

Action

Coupon

fixedAmountOptions

percentageOptions

Limit the coupon to carts with a subtotal above this number.

minimumSubtotal

Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).

scope

Whether the coupon applies to subscription products.

appliesToSubscriptions

boolean

Coupon discount type.

- `UNKNOWN`: Unknown discount type.
- `FIXED_AMOUNT`: Discount as a fixed amount.
- `PERCENTAGE`: Discount as a perctange.
- `FREE_SHIPPING`: Free shipping. If `true`, the coupon applies to all items in all `namespaces`.

discountType

DiscountType

Specifies the amount of discounted cycles for a subscription item.

- Can only be set when `scope.namespace = pricingPlans`.
- If `discountedCycleCount` is empty, the coupon applies to all available cycles.
- `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.

Max: `999`

discountedCycleCount

number

Whether the coupon is limited to one item.
If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
Coupons with a bookings `scope.namespace` are always limited to one item.

limitedToOneItem

name

CouponScope

Coupon scope's applied group, for example, Event or ticket in Wix Events.

group

Group

Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans)

namespace

Emails

Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.

Available apps:

- `UNKNOWN`: Unknown email.
- `STORES`: Send an email to customers who've placed an order with stores.
- `PRICING_PLANS`: Send an email to customers who've placed an order with pricing plans.
- `EVENTS`: Send an email to customers who've placed an order with events.
- `BOOKINGS`: Send an email to customers who've placed an order with bookings.
- `RESTAURANTS`: Send an email to customers who've placed an order with restaurants.

encourageToReferFriends

Whether to send email notifications to referring customers when they receive a referral reward.
If true, referring customers will be notified by email when their referred friend completes a qualifying action (for example, placing an order).

notifyCustomersAboutReward

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

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

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

FixedAmountDiscount

amount

referFriendsPageUrl

suggestions

Topic to generate social media post suggestions for. For example, fitness, education, technology.

topic

Whether the site has the referral program feature enabled.

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

LoyaltyPoints

OnProgramUpdatedHandler

event

ProgramUpdatedEnvelope

void

PercentageDiscount

percentage

PremiumFeatures

Whether the site owner has access to the referral program feature.

ProgramStatus

entity

metadata

_createdDate

Date and time the program was last updated.

_updatedDate

Configures email notifications for the referral program.

emails

Indicates which premium features are available for the current account.

premiumFeatures

Reward configuration for the referred friend.
Specifies the reward given to a new customer who was referred to the business.

referredFriendReward

Reward

Reward configuration for the referring customer.
Specifies the reward given to an existing customer who referred a new customer to the business.

activateReferralProgram( )