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)

Retrieves data about the instance of your app that's installed on the Wix
site and the site itself.


You don't have to explicitly pass an identifier for the Wix site as part of
the request, since this information is taken automatically from the context.

In case you want `site.ownerInfo` to be included in the response, you must
have the __Read Site Owner Email__ permission scope in addition to
__WIX_DEVELOPERS.MANAGE_APP_INSTANCE__.

import { appInstances } from '@wix/app-management';

async function getAppInstance() {
  const response = await appInstances.getAppInstance();
};

getAppInstance: Wix-hosted

// Import the client, the auth strategy for the relevant access type, and the relevant host module

import { appInstances } from '@wix/app-management';

const wixClient = // Create a client with the relevant module, auth strategy, and host module;

async function getAppInstance() {
  const response = await wixClient.appInstances.getAppInstance();
};

Learn more about [access types](https://dev.wix.com/docs/sdk/articles/getting-started/access-types-and-permissions) and [host modules](https://dev.wix.com/docs/sdk/articles/getting-started/about-host-modules).

getAppInstance: Self hosted

getAppInstance

GetAppInstanceResponse

# About the App Instances API

The App Instances API allows to track on which Wix sites your app is installed and when a subscription for your app is modified.

With the App Instances API, you can:

* Get notified by Wix when a site owner installs your app on their site.
* Track data that's associated with individual app instances.
* Receive notifications from Wix when site owners modify or cancel their subscription for your app.

For more information how to charge site owners for using your app, see the [Billing API](https://dev.wix.com/docs/sdk/backend-modules/app-management/billing/introduction).

## Before you begin

Before you begin coding, it's important to consider that site owners can install only a single version of your app on their site. For example, they can't install a free and paid version of your app at the same time.

## Example use cases

* Reach out to new users
* Send site owners a discount code when they downgrade their plan for your app

## Terminology

* **App instance:** A specific occurrence of your app on a particular Wix site.
* **Paid plan:** The site owners have installed a version of your app that isn't free of charge. Your app can charge a single one-time payment or on a subscription basis.

To use the AppInstances API, install the `@wix/app-management` package using npm or Yarn:
  ```console
npm install @wix/app-management
```

or

```console
yarn add @wix/app-management
```

Then import `{ appInstances }` from `@wix/app-management`:

```js
import { appInstances } from '@wix/app-management'
```
  

app-management_app-instances

AppInstalled

Unique identifier of the app within the website.

appId

string

Instance ID of the app in the original website (relevant only when this site was [duplicated from another site](https://support.wix.com/en/article/duplicating-your-site-1472847)).

originInstanceId

AppInstance

App name, as set by you in the Wix Developers Center during the app creation
process.

appName

Version of your app that's installed on the Wix site, as set by you in the
Wix Developers Center during the app creation process.

appVersion

availablePlans

Billing information for the app instance. Available only in case
`{"isFree": false}`.

billing

BillingInfo

Whether the app instance was created when another Wix site was cloned.

copiedFromTemplate

boolean

Whether the app instance includes a free trial that hasn't started yet.

freeTrialAvailable

ID of the app instance. You can use it to keep track of the individual
data that's associated with the specific occurence of your app that's
installed on a Wix site.

instanceId

Whether the site owners have installed a free or paid version of your app
on their site.

isFree

__Deprecated__. This parameter will be removed on March 30, 2023. Use
`copiedFromTemplate` instead.

isOriginSiteTemplate

ID of the Wix site from which the instance of your app has been cloned.
Available only in case `{"copiedFromTemplate": true}`.
All visual settings of the Wix site and app data are duplicated during the
cloning process. Wix also notifies you in case there is any additional
external functionality for the original site.

List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
that the site owners have granted your app. You set the list of permissions that
your app requires from the site owners in the Wix Developers Center during the
app creation process.

permissions

AppInstanceInstalledEnvelope

data

metadata

BaseEventMetadata

AppInstancePaidPlanAutoRenewalCancelledEnvelope

PaidPlanAutoRenewalCancelled

AppInstancePaidPlanChangedEnvelope

PaidPlanChanged

AppInstancePaidPlanPurchasedEnvelope

PaidPlanPurchased

AppInstanceRemovedEnvelope

AppRemoved

AvailablePlan

packageName

Source of the available plan. Can be a bundle or 3rd-party app.

source

eventType

The identification type and identity data.

identity

IdentificationData

Whether the app's subscription automatically renews at the end of the
current billing cycle.

autoRenewing

Interval of the billing cycle. `"ONE_TIME"` means that site owners have
purchased unlimited access to the app with a single, upfront payment.

billingCycle

PaymentCycle

Date and time the app's current billing cycle ends in
`YYYY-MM-DDThh:mm:ss.sssZ` format. Available only for yearly and
multi-yearly plans.

expirationDate

Information about the free trial applied, if relevant.

freeTrialInfo

FreeTrialInfo

ID of the invoice for the current billing cycle.

invoiceId

Name of the package that the site owner has paid for.

Information about any discounts applied to the app instance's current billing cycle.
If the site owners applied a developer coupon or Wix Voucher
when installing the paid version of your app, this field holds the coupon's
name or `“Wix discount coupon”`. Site owners may receive a Wix Voucher when
upgrading their Wix subscription. If there is no discount for the
current billing cycle, the field is an empty string.

Date and time the site owners have purchased the app's paid plan in
`YYYY-MM-DDThh:mm:ss.sssZ` format.

timeStamp

When the free trial has ended. Populated only once the free trial is over.

endDate

Current free trial status.

Supported values:

- `IN_PROGRESS`: The free trial is currently in progress.
- `ENDED`: The free trial has ended.
- `NOT_AVAILABLE`: No free trial was applied, as none was available.

status

FreeTrialStatus

instance

Information about the corresponding Wix site.

site

SiteInfo

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

WebhookIdentityType

Multilingual

Whether the site supports more than a single language.

isMultiLingual

List of supported languages. Returned only when `{"isMultiLingual": true}`.

supportedLanguages

OnAppInstanceInstalledHandler

event

void

OnAppInstancePaidPlanAutoRenewalCancelledHandler

OnAppInstancePaidPlanChangedHandler

OnAppInstancePaidPlanPurchasedHandler

OnAppInstanceRemovedHandler

OwnerInfo

Site owner's email address. Identical to the site owner's login email.

email

Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
`NOT_VERIFIED_OPT_IN`, `NOT_VERIFIED_OPT_OUT`.

Whether the site owner has verified their email and whether they have chosen
to receive email notifications from Wix.

emailStatus

Supported values: `UNKNOWN_CANCELLATION_TYPE_ERROR_STATE`, `USER_CANCEL`, `FAILED_PAYMENT`, `TRANSFER_CANCELLATION_REASON`. Reason provided by app for cancellation (if relevant).

cancelReason

cycle

Date and time of auto-renewal cancellation.

operationTimeStamp

subscriptionCancellationType

Reason provided by site owner for cancellation (if relevant).

userReason

vendorProductId

Coupon applied to purchase (if relevant).

couponName

previousCycle

previousVendorProductId

expiresOn

ResolutionMethod

description

installedWixApps

2-letter language code of the site's locale in
[ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

locale

Information about the site's supported languages.

multilingual

> **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.

ownerEmail

Information about the site owner. Available only when calling
_Get App Instance_ with the __Read Site Owner Email__ permission scope.

ownerInfo

3-letter currency code for the site's billing in
[ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.

paymentCurrency

siteDisplayName

siteId

URL of the site. Available only in case the site has been published.

SupportedLanguage

countryCode

Whether the supported language is the primary language for the site.

isPrimary

Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

languageCode

Locale

How the language will be resolved. For internal use.

resolutionMethod

handler

Triggered when an instance of your app is installed on a Wix site.

import { appInstances } from '@wix/app-management';

appInstances.onAppInstanceInstalled((event) => {
    // handle your event here
});

Setup