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)

event

ConversationConversationsMerged

Triggered when the conversation
is merged, for example when contacts are merged
or when a visitor becomes a contact.

If messages exist in both conversations when they merge,
the messages are preserved in chronological order.


  export function wixCrmInbox_onConversationConversationsMerged(event) {
    const eventId = event.metadata.id
    const entityId = event.data.conversation._id;
  }

  

onConversationConversationsMerged example

onConversationConversationsMerged

void

Information about the button interaction and metadata for the event.

MessageButtonInteracted

An event that triggers when a postback button is clicked.

The `onMessageButtonInteracted()` event handler runs when contact, member, or site visitor clicks on a postback button that was sent with a message. The received `MessageButtonInteracted` object contains information about the interaction with the postback button.

>**Note:** Backend events don't work when previewing your site.

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixCrmInbox_onMessageButtonInteracted(event) {
  const eventId = event.metadata.id;
  const messageId = event.data.message._id;
}

/* Full event object:
 * {
 *   "data": {
 *     "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a",
 *     "conversationId": "6fd2b962-dd8f-382f-8d27-ae63f188c939",
 *     "interactedBy": {
 *       "contactId": "9e668c08-8bdb-4240-babb-8176935f6f78"
 *     },
 *     "interactionId": "spa_day_54321__change_appointment"
 *   },
 *   "metadata": {
 *     "entityId": "4b0d9a97-7c33-4ee9-945d-6a2f82d2f26d",
 *     "eventTime": "2023-11-15T15:24:51.096099Z",
 *     "id": "4fe18293-0a00-4650-be2e-ba754ee5cba0",
 *     "triggeredByAnonymizeRequest": false
 *   }
 * }
 */



An event triggered when a postback button is clicked  

onMessageButtonInteracted

Information about the message that was sent and metadata for the event.

MessageSentToBusinessEvent

An event that triggers when a contact, member, or site visitor sends a message to a business.

The `onMessageSentToBusiness()` event handler runs when a message is sent from a site's contact, member, or visitor to a business. The received `MessageSentToBusinessEvent` object contains information about the message that was sent.

>**Note:** Backend events don't work when previewing your site.

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixCrmInbox_onMessageSentToBusiness(event) {
  const eventId = event.metadata.id;
  const messageId = event.data.message._id;
  const conversationId = event.data.conversationId;
}

/* Full event object:
 * {
 *   "data": {
 *     "conversationId": "6fd2b962-dd8f-382f-8d27-ae63f188c939",
 *     "message": {
 *       "_createdDate": "2023-11-15T10:19:44.064Z",
 *       "_id": "1700043584064712",
 *       "appId": "14517e1a-3ff0-af98-408e-2bd6953c36a2",
 *       "badges": [],
 *       "content": {
 *         "previewText": "You are very welcome.",
 *         "basic": {
 *           "items": [
 *             {
 *               "text": "You are very welcome."
 *             }
 *           ]
 *         },
 *         "contentType": "BASIC"
 *       },
 *       "direction": "PARTICIPANT_TO_BUSINESS",
 *       "sender": {
 *         "contactId": "9e668c08-8bdb-4240-babb-8176935f6f78"
 *       },
 *       "sequence": "1700043584064712",
 *       "sourceChannel": "UNKNOWN_CHANNEL_TYPE",
 *       "targetChannels": [],
 *       "visibility": "BUSINESS_AND_PARTICIPANT"
 *     }
 *   },
 *   "metadata": {
 *     "entityId": "1700043584064712",
 *     "eventTime": "2023-11-15T10:19:45.472455Z",
 *     "id": "45289008-1d03-4697-9cc2-a0c0f12cf823",
 *     "triggeredByAnonymizeRequest": false
 *   }
 * }
 */

An event when the site user messages the business site  

onMessageSentToBusiness

MessageSentToParticipantEvent

An event that triggers when a business sends a message to a contact, member, or site visitor.

The `onMessageSentToParticipant()` event handler runs when a message is sent from a business to a site's contact, member, or visitor. The received `MessageSentToParticipantEvent` object contains information about the message that was sent.

>**Note:** Backend events don't work when previewing your site.

// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.

export function wixCrmInbox_onMessageSentToParticipant(event) {
    const eventId = event.metadata.id;
    const messageId = event.data.message._id;
    const conversationId = event.data.conversationId;
  }
  
/* Full event object:
 * {
 *   "data": {
 *     "conversationId": "6fd2b962-dd8f-382f-8d27-ae63f188c939",
 *     "message": {
 *       "_createdDate": "2023-11-15T16:18:56.558Z",
 *       "_id": "1700065136558061",
 *       "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a",
 *       "badges": [],
 *       "content": {
 *         "previewText": "Thank You",
 *         "basic": {
 *           "items": [
 *             {
 *               "text": "Thank you for submitting!"
 *             }
 *           ]
 *         },
 *         "contentType": "BASIC"
 *       },
 *       "direction": "BUSINESS_TO_PARTICIPANT",
 *       "sender": {
 *         "wixUserId": "b17c523c-6ec9-4b56-9d9d-123cc6978bdf"
 *       },
 *       "sequence": "1700065136558061",
 *       "sourceChannel": "UNKNOWN_CHANNEL_TYPE",
 *       "targetChannels": [],
 *       "visibility": "BUSINESS_AND_PARTICIPANT"
 *     },
 *   }
 *   "metadata": {
 *     "id": "2715920c-e7d4-4bd0-ab00-33cb3fe01a9f",
 *     "entityId": "1700065136558061",
 *     "eventTime": "2023-11-15T16:18:56.681603Z",
 *     "triggeredByAnonymizeRequest": false
 *   }
 * }
 */

An event triggered when the business site messages the site user  

onMessageSentToParticipant

velo-events_wix-inbox.v2

BackendEventMetadata

ID of the entity associated with the event.

entityId

string

eventTime

Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.

triggeredByAnonymizeRequest

boolean

data

ConversationsMerged

metadata

oldConversationIds

targetConversationId

Badge

Controls whether the badge is visible to the participant.
Currently not supported in the Chat widget.

badgeVisibility

BadgeVisibility

iconUrl

text

BasicMessageData

File attachment.
Can contain a file from Wix Media or an external provider.

file

Image message.
Can contain an image from Wix Media
or from an external provider.

image

BasicMessagePayload

List of plain text messages, images, and/or files.
List items are displayed as separate messages
in Inbox and the site's chat widget.

items

Button

label

If included, the button launches the specified URL.

launchUrl

Properties to pass to the
[Button Interacted webhook](https://dev.wix.com/api/rest/inbox/messages/button-interacted-webhook)
when the button is clicked.

postbackProperties

PostbackProperties

ButtonInteracted

[Your app's](https://dev.wix.com/dc3/my-apps) app ID.

appId

conversationId

ID of the participant who pressed the button.

interactedBy

IdentificationData

ID you define for the interaction,
to be handled by your server.

interactionId

ChannelType

ContentType

CustomMessageData

appData

appName

FileMessage

filename

File [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).

mimeType

FormField

name

value

FormMessagePayload

Form description displayed below the title.

description

fields

List of files and/or images attached to the form.

List items are displayed as separate messages
in Inbox and the site's chat widget.

media

title

anonymousVisitorId

Site
[member](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/members)
ID.

memberId

User ID of the site owner or a site contributor.

wixUserId

Optional site
[contact](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts) ID.

contactId

ImageMessage

height

number

width

InteractionInfo

MediaItem

Message

_createdDate

ID of the application that sent the message.

Omitted if the message was sent with the Chat widget.

Optional icon and short text providing additional details about the message,
such as the app from which the message was sent, or whether the message was an automated response.

Currently only 1 badge is supported.

badges

content

MessageContent

__Required.__
Message direction.

- `BUSINESS_TO_PARTICIPANT`: The message was sent from the business to the participant.
- `PARTICIPANT_TO_BUSINESS`: The message was sent from the participant to the business.

direction

MessageDirection

ID of the message sender.

Defaults to the caller's ID
using the property that matches their identity type.
For 3rd-party apps, defaults to using the app's `appId`.

You can override the default behavior when calling
[Send Message](https://dev.wix.com/api/rest/inbox/messages/send-message)
by using the `sendAs` parameter.

sender

Sequential ordering of the message.

Ensures more accurate sorting than `createdDate`
if two messages are sent at the same time.

sequence

Communication channel the message is sent from.

sourceChannel

Communication channel to send the message to.

Currently messages can be sent to 1 channel only.

targetChannels

__Required.__
Controls who can see the message.

- `BUSINESS_AND_PARTICIPANT`: Visible to the participant and site collaborators.
- `BUSINESS`: Visible to site collaborators only.

visibility

MessageVisibility

basic

Message containing submitted form data.
Typically sent with a `direction` of `PARTICIPANT_TO_BUSINESS`
and message `visibility` of `BUSINESS`.

form

Minimal message containing a single line of text
and an optional icon.
Often reports an activity that took place.

minimal

system

Template containing an image, title, text,
and/or up to 10 call-to-action buttons.

template

Summary of message contents.
Displayed in Inbox in the
[Message List](https://support.wix.com/en/article/wix-inbox-getting-started#view-your-messages).

previewText

MessageSentToBusiness

Optional info about interaction with app done by the user

interactionInfo

message

MessageSentToParticipant

MinimalMessagePayload

If included, URL the user is redirected to when clicking the message.

Orientation

[Your app's](https://dev.wix.com/dc3/my-apps) App ID.

ID you define for the interaction, to be handled by your server.

SystemMessagePayload

List of buttons to display with the message.
Buttons can either open a URL or pass interaction details to the
[Button Interacted Webhook](https://dev.wix.com/api/rest/all-apis/inbox/button-interacted-webhook).

Maximum: 10 buttons.

buttons

imageUrl

Text message. `\n` renders as a line break.

TemplateMessagePayload

Controls whether the message is displayed in portrait or landscape layout.

Default: `PORTRAIT`.

orientation

List of lines of text. Each item in the array is displayed on a new line.

Max: 10 lines (up to 512 characters per line).

onMessageSentToParticipant( )