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)

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token
from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

Number of domains to load.

Min: `0`
Max: `100`

limit

CursorPaging

Number of domains returned in the response.

count

Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.

Indicates if there are more results after the current page.
If `true`, another page of results can be retrieved.
If `false`, this is the last page.

hasNext

CursorPagingMetadata

Cursor pointing to next page in the list of results.

Cursors

Domain name including TLD.
Both root domains and subdomains are supported.

domain

DomainRemovedEvent

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

AssignmentType

A `connectedDomain` object holds information about an external domain and its connection to a Wix site.

How the domain is connected to the Wix site.

+ `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
+ `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
+ `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
+ `"HIDDEN"`: The domain isn't visible to site visitors.

connectionType

DNS propagation status.

+ `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
+ `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
+ `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
+ `"FAILED"`: The domain's DNS propagation process has failed.

dnsPropagationStatus

ID of the connected domain. Identical to the domain name including TLD.

Information about the site to which the domain is assigned, and whether
it's the primary domain or a redirect.

Whether the site owner receives standard email notifications from Wix about
the connected domain.

Default: `false`

suppressNotifications

ConnectedDomain

ConnectionType

CreateConnectedDomainRequest

CreateConnectedDomainResponse

ID of the connected domain to delete. Identical to the domain name including TLD.

connectedDomainId

DeleteConnectedDomainRequest

DeleteConnectedDomainResponse

DnsPropagationStatus

GetConnectedDomainRequest

GetConnectedDomainResponse

ListConnectedDomainsRequest

connectedDomains

Metadata about the returned list of connected domains.

ListConnectedDomainsResponse

Primary domain to which this domain will redirect.

primaryDomain

RedirectAssignmentInfo

The relationship assigned for this domain to the site:
+ `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
+ `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
+ `"REDIRECT"`: A redirect domain for a site. Each site can have multiple redirect domains. When this type is assigned, this domain will redirect to the primary domain.
Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).

assignmentType

ID of the site to which the domain is assigned.

SiteInfo

Redirect information, relevant when `assignmentType` = `REDIRECT`.

assignmentInfo

value

BoolValue

Int32Value

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

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

Retrieves a list of up to 100 connected domains.


You must pass the relevant Wix account ID in the header of the call.

The retrieved domains are sorted by `createdDate` in descending order.

> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.

Retrieve a list of connected domains.

ListConnectedDomains

paging

Creates a `connectedDomain` object and starts the domain connection process.
It may take up to 48 hours for the DNS changes to take effect.


You must pass the relevant Wix account ID in the header of the call.
You may also pass a Wix site ID in the header.

You can only connect external domains using this endpoint. Domains purchased
and billed through Wix can't be connected via this endpoint to a Wix site. For those
domains use the [Registered Domains API](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/account-level-apis/registered-domains/introduction)
instead.

You can connect both root domains and subdomains to Wix sites.

The domain can be assigned as a primary domain or a redirect.
You can read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
If you connect a domain as `"PRIMARY"` to a Wix site, the existing primary
domain automatically becomes unassigned.

> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.

Connect a subdomain

CreateConnectedDomain

Connect a domain using nameservers

Connect a domain by pointing

Retrieves a connected domain.


You must pass the relevant Wix account ID in the header of the call.

> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.

Retrieve a connected domain.

GetConnectedDomain

Deletes a `connectedDomain` object and removes related DNS records from
[Google's Cloud DNS](https://cloud.google.com/dns).


You must pass the relevant Wix account ID in the header of the call.

If you delete a `"PRIMARY"` domain, the site automatically uses the standard
URL for free Wix sites. Read more about
[URLs of free Wix sites](https://support.wix.com/en/article/changing-your-free-wix-url-8591528).

When you delete a subdomain, its CNAME record is deleted from Google's Cloud DNS.

> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.

Delete Connected Domain