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)

payload

GetEligibleTriggersEnvelope

Retrieves eligible custom discount triggers based on the provided items.

This method is automatically called by Wix eCommerce to retrieve the custom discount triggers provided by your extension.
This happens when actions are performed on the cart and checkout entities/pages. For example, when an item is added to the cart.

import { customTriggers } from '@wix/ecom/service-plugins';

customTriggers.provideHandlers({

  getEligibleTriggers: async ( payload ) => {
    const {request, metadata} = payload;
        // Use the `request` and `metadata` received from Wix and
        // apply custom logic.
      return {
        // Return your response exactly as documented to integrate with Wix.
        // Return value example:
        eligibleTriggers: [
          {
            customTriggerId: "my-happy-hour-trigger",
            identifier: "123"
          },
          {
            customTriggerId: "my-digital-sale-trigger",
            identifier: "234"
          }
        ]
      }
    }
});


Example of an `eligibleTriggers` return value 

getEligibleTriggers

GetEligibleTriggersResponse

ListTriggersEnvelope

Lists all custom triggers provided by your service plugin integration.

This method is automatically called by Wix eCommerce to populate the custom [minimum requirements section of an automatic discount](https://support.wix.com/en/article/wix-stores-creating-automatic-discounts#:~:text=Create%20minimum%20requirements).

import { customTriggers } from '@wix/ecom/service-plugins';

customTriggers.provideHandlers({

  listTriggers: async ( payload ) => {
    const {request, metadata} = payload;
        // Use the `request` and `metadata` received from Wix and
        // apply custom logic.
      return {
        // Return your response exactly as documented to integrate with Wix.
        // Return value example:
        customTriggers: [
          {
            _id: "my-happy-hour-trigger",
            name: "Happy Hour 16:00-18:00"
          },
          {
            _id: "my-digital-sale-trigger",
            name: "Digital products discount"
          }
        ]
      }
    }
});


Example of a `customTriggers` return value 

listTriggers

ListTriggersResponse

# About the Custom Discount Triggers Service Plugin

As a discount trigger provider, you can integrate with Wix to provide a merchant's stores or businesses with custom triggers that specify when a discount applies on the site's cart and checkout pages. Together with [discount rules](https://dev.wix.com/docs/sdk/backend-modules/ecom/discount-rules/), custom triggers define the necessary conditions for a discount to apply. For example, a trigger that only fires between 4pm-6pm on Mondays through Thursdays.

The integration is done via an app in the Wix App Market and by implementing the Custom Discount Triggers [service plugin](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/service-plugins/about-service-plugin-extensions). After the app is installed on a site, Wix triggers a call to your service whenever actions are performed on the cart or checkout entities/pages. For example, when adding an item to the cart.

Using the service plugin, you can design your app to:

+ Offer a happy hour discount.
+ Offer a sale on digital products.

## Before you begin

To use a custom trigger to apply a discount, you must first create a discount rule. Create an automatic discount [using the dashboard](https://support.wix.com/en/article/wix-stores-creating-automatic-discounts), or by using the [Discount Rules API](https://dev.wix.com/docs/sdk/backend-modules/ecom/discount-rules/).

## Get started

Follow these steps to begin implementing your service plugin.

### Choose a framework

You can implement this service plugin with the following [frameworks](https://dev.wix.com/docs/build-apps/get-started/overview/wix-s-development-frameworks):

+ **Wix CLI:** Learn how to [implement a service plugin with the CLI and the SDK](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/supported-extensions/backend-extensions/service-plugins/add-service-plugin-extensions-with-the-cli).
+ **Self-hosted:** Learn how to [implement a self-hosted service plugin with the SDK and the Wix Dev Center](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions-with-the-sdk).

### Configure your service plugin

To configure and customize your plugin, you need to provide important information in the service plugin configuration file. You can [configure your plugin in the Wix Dev Center](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions-with-the-sdk#step-1--add-a-service-plugin-extension-to-your-app). For details, see [Custom Discount Trigger Extension Configuration](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/custom-triggers/extension-config).

### Define handler functions

Use [`customTriggers.provideHandlers()`](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions-with-the-sdk#step-4--define-handler-functions) to define the following handler functions that implement your custom business logic. Make sure you define all required functions.

| Function                    | Required       |
|-----------------------------|----------------|
| [`getEligibleTriggers()`](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/custom-discount-triggers/get-eligible-triggers)    | Yes            |
| [`listTriggers()`](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/custom-discount-triggers/list-triggers)    | Yes            |

## Code examples

Below is an example for implementing the Custom Discount Triggers service plugin in your code.

### CLI: Basic code structure

This is the basic code structure for implementing the Custom Discount Triggers service plugin with the Wix CLI:

```js
import { customTriggers } from '@wix/ecom/service-plugins'

customTriggers.provideHandlers({
  getEligibleTriggers: async (payload) => {

    const {request, metadata} = payload;

    // Add your logic here

  },
  listTriggers: async (payload) => {

    const {request, metadata} = payload;

    // Add your logic here

  }  
});
  
```

### Self-hosted: Basic code structure

This is the basic code structure for implementing a self-hosted Custom Discount Triggers service plugin:

```js
import { createClient } from '@wix/sdk';
import { customTriggers } from '@wix/ecom/service-plugins'

const wixClient = createClient({
  auth: {
    appId: <YOUR_APP_ID>,
    publicKey: <YOUR_APP_PUBLIC_KEY>
  },
  modules: { customTriggers }
});

wixClient.customTriggers.provideHandlers({
  getEligibleTriggers: async (payload) => {

    const { request, metadata } = payload;

    // Add your logic here

  },
  listTriggers: async (payload) => {

    const { request, metadata } = payload;

    // Add your logic here

  }  
});

// Implement a router to process all requests
express.post('/plugins-and-webhooks/*', (req, res) => {
  wixClient.process(req);
});
  
```

## See also

+ [About Service Plugin Extensions](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/service-plugins/about-service-plugin-extensions)
+ [Add a Service Plugin Extension With the CLI](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/supported-extensions/backend-extensions/service-plugins/add-service-plugin-extensions-with-the-cli)
+ [Add a Self-hosted Service Plugin With the SDK](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions-with-the-sdk)


ecom_custom-triggers

To configure and customize your service plugin, you need to provide important details in the `plugin.json` configuration file.

{
  "deploymentUri": "https://my-discount-app.com/"
}


Custom Triggers Extension Config

Extension Config

CustomTriggerConfig

CatalogReference

ID of the app providing the catalog.

You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).

For items from Wix catalogs, the following values always apply:
+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`

appId

string

ID of the item within the catalog it belongs to.

catalogItemId

Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.

For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).

options

Context

[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.

currency

An object that describes the identity that triggered this request.

identity

IdentificationData

instanceId

A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`.

languages

A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs.

requestId

CustomTrigger

Required. Base URI where the endpoints are called.
Wix appends the endpoint path to the base URI. For example, to call the Get Eligible Triggers endpoint at `https://my-discount-app.com/v1/getEligibleTriggers`, the base URI you provide here is `https://my-discount-app.com/`.

deploymentUri

EligibleTrigger

Custom trigger ID. Must be passed with relevant `identifier`.

customTriggerId

Unique trigger identifier. The value must be the same as its equivalent in `triggers[i].identifier` in the request payload.

identifier

metadata

request

GetEligibleTriggersRequest

lineItems

Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.

purchaseFlowId

List of triggers to be checked for discount eligibility.

triggers

List of eligible triggers. These are used by the Discount Rules API and Wix eCommerce to apply the relevant discount.

eligibleTriggers

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

IdentityType

LineItem

Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info.
This field is empty in the case of a custom line item.

catalogReference

price

quantity

number

ListTriggersRequest

customTriggers

ListTriggersResponseCustomTrigger

Custom trigger name to display in the dashboard.

name

TriggerToFilterBy

customTrigger

Unique trigger identifier. The same value must be returned in `eligibleTriggers[i].identifier`.

Extension Config

listTriggers( )