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)

groupId

string

memberIds

role

GroupRole

options

AssignRoleOptions

Assigns a specific role to group members.


>**Note:** This function is only relevant for site admins, and group members with group admin permissions.

The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.

import { roles } from '@wix/groups';

async function assignRole(groupId, memberIds, role, options) {
  const response = await roles.assignRole(groupId, memberIds, role, options);
};

assignRole: Wix-hosted

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

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


async function assignRole(groupId, memberIds, role, options) {
  const response = await myWixClient.roles.assignRole(groupId, memberIds, role, options);
};

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

assignRole: Self-hosted

assignRole

AssignRoleResponse

UnassignRoleOptions

Unassigns a role from group members.

>**Note:** This function is only relevant for site admins, and group members with group admin permissions.

The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.

import { roles } from '@wix/groups';

async function unassignRole(groupId, memberIds, role, options) {
  const response = await roles.unassignRole(groupId, memberIds, role, options);
};

unassignRole: Wix-hosted

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

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


async function unassignRole(groupId, memberIds, role, options) {
  const response = await myWixClient.roles.unassignRole(groupId, memberIds, role, options);
};

unassignRole: Self-hosted

unassignRole

UnassignRoleResponse

---
title: Introduction
---

# About the Roles API

The Roles API provides functionality for managing roles of group [members](members). 
 
With the Roles API, you can:

- [Assign](groups/roles/assign-role) a role to specific group members.
- [Unassign](groups/roles/unassign-role) a role from specific group members.


## Before you begin
It is important to note that this module is only relevant for site admins and group admins.


## Terminology

- **Site Admin**: A site owner or site collaborator with admin permissions.
- **Group Member**: A site member belonging to a group.
- **Group Admin**: A group member that was assigned the 'group admin' role by either the site admin, or another group admin. The creator of a group is automatically a group admin. The group admin has the same permissions as a site admin, but only for the specified group.


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

or

```console
yarn add @wix/groups
```

Then import `{ roles }` from `@wix/groups`:

```js
import { roles } from '@wix/groups'
```
  

groups_roles

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

boolean

GroupMember

Date and time the group Member joined the group.

joinedDate

Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.

memberId

__Deprecated.__ Use `memberId` instead.
This property will be removed on June 30, 2022.

siteMemberId

Member's role.
- `MEMBER` - Regular group member.
- `ADMIN` - Group administrator.

value

Role

GroupRoleAssignedEnvelope

data

RoleAssignedToGroupMember

metadata

GroupRoleUnassignedEnvelope

RoleUnassignedFromGroupMember

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.

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

wixUserId

identityType

WebhookIdentityType

OnGroupRoleAssignedHandler

event

void

OnGroupRoleUnassignedHandler

ID of site member who assigned the role. It can be empty if the role was assigned by a third-party application.

assignedById

Group member to whom the role was assigned.

groupMember

ID of site member who unassigned the role. It can be empty if the role was assigned by a third-party application.

unassignedById

handler

Triggered when a role is assigned to an existing member.

import { roles } from '@wix/groups';

roles.onGroupRoleAssigned((event) => {
    // handle your event here
});

onGroupRoleAssigned: Wix-hosted

import { createClient, AppStrategy } from '@wix/sdk';
import { roles } from '@wix/groups';

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

wixClient.roles.onGroupRoleAssigned((event) => {
    // handle your event here
});

onGroupRoleAssigned: Self-hosted

onGroupRoleAssigned

Triggered when a role is removed from a member.

import { roles } from '@wix/groups';

roles.onGroupRoleUnassigned((event) => {
    // handle your event here
});

onGroupRoleUnassigned: Wix-hosted

import { createClient, AppStrategy } from '@wix/sdk';
import { roles } from '@wix/groups';

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

wixClient.roles.onGroupRoleUnassigned((event) => {
    // handle your event here
});

assignRole( )