Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

ID of the conversation that contains the intended messages.

conversationId

string

__Required.__
Filters for messages with the specified visibility setting.

- `BUSINESS_AND_PARTICIPANT`: Return messages visible to the business and the participant.
- `BUSINESS`: Return all messages.

visibility

MessageVisibility

options

ListMessagesOptions

Retrieves messages between the business and participant.


Up to 30 messages are returned per request. If the number of messages in a conversation is larger than 30,
`pagingMetadata.cursors` is returned in the response, indicating that another page of results is available.
To retrieve the next page of messages, pass the `next` cursor value
in the next request's `paging.cursor` parameter.

To ensure you'll always retrieve the next record,
use the same visibility and sorting
in the first request and all subsequent requests.

By default,
30 messages are retrieved and sorted by `sequence` in descending order
(the most recent messages are first in the list).

import { messages } from 'wix-inbox.v2';

/* Sample conversationId value: '9ac410b1-17f8-3b10-a3f4-0dd5c295d510'
 * 
 * Sample visibility value: 'BUSINESS_AND_PARTICIPANT'
 */

export async function myListMessagesFunction(conversationId, visibility) {
  
  try {
    const messageList = await messages.listMessages(conversationId, visibility);
    const firstSender = messageList.messages[0].sender;
    
    return messageList;
  } catch(error) {
    console.error(error);
    // Handle the error
  }
}

/* Promise resolves to:
 * {
 *   "messages": [
 *     {
 *       "_createdDate": "2023-12-28T09:41:06.660Z",
 *       "_id": "1703756466660667",
 *       "appId": "14517e1a-3ff0-af98-408e-2bd6953c36a2",
 *       "badges": [],
 *       "content": {
 *         "previewText": "thanks for the content",
 *         "basic": {
 *           "items": [
 *             {
 *               "text": "thanks for the content"
 *             }
 *           ]
 *         },
 *       },
 *       "direction": "PARTICIPANT_TO_BUSINESS",
 *       "sender": {
 *         "anonymousVisitorId": "3c06d38d-1433-4889-b303-1ff1779176e6"
 *       },
 *       "sequence": "1703756466660667",
 *       "sourceChannel": "UNKNOWN_CHANNEL_TYPE",
 *       "targetChannels": [],
 *       "visibility": "BUSINESS_AND_PARTICIPANT",
 *     },
 *     {
 *       "_createdDate": "2023-12-27T16:16:07.816Z",
 *       "_id": "1703693767816923",
 *       "badges": [],
 *       "content": {
 *         "previewText": "Thanks for the like :)",
 *         "basic": {
 *           "items": [
 *             {
 *               "text": "Thanks for the like :)"
 *             }
 *           ]
 *         },
 *       },
 *       "direction": "BUSINESS_TO_PARTICIPANT",
 *       "sender": {
 *         "wixUserId": "b17c523c-6ec9-4b56-9d9d-123cc6978bdf"
 *       },
 *       "sequence": "1703693767816923",
 *       "sourceChannel": "UNKNOWN_CHANNEL_TYPE",
 *       "targetChannels": [
 *         "CHAT"
 *       ],
 *       "visibility": "BUSINESS_AND_PARTICIPANT",
 *     }
 *   ],
 *   "pagingMetadata": {
 *     "tooManyToCount": true
 *   }
 * }
 */

View a list of sent messages (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { messages } from 'wix-inbox.v2';
import { elevate } from 'wix-auth';

/* Sample conversationId value: '9ac410b1-17f8-3b10-a3f4-0dd5c295d510'
 * 
 * Sample visibility value: 'BUSINESS_AND_PARTICIPANT'
 */

export const myListMessagesFunction = webMethod(Permissions.Anyone, async (conversationId, visibility) => {
  try {
    const elevatedListMessages = elevate(messages.listMessages);
    const messageList = await elevatedListMessages(conversationId, visibility);
    const firstSender = messageList.messages[0].sender;
    
    return messageList;
  } catch(error) {
    console.error(error);
    // Handle the error
  }
});

/* Promise resolves to:
 * {
 *   "messages": [
 *     {
 *       "_createdDate": "2023-12-28T09:41:06.660Z",
 *       "_id": "1703756466660667",
 *       "appId": "14517e1a-3ff0-af98-408e-2bd6953c36a2",
 *       "badges": [],
 *       "content": {
 *         "previewText": "thanks for the content",
 *         "basic": {
 *           "items": [
 *             {
 *               "text": "thanks for the content"
 *             }
 *           ]
 *         },
 *       },
 *       "direction": "PARTICIPANT_TO_BUSINESS",
 *       "sender": {
 *         "anonymousVisitorId": "3c06d38d-1433-4889-b303-1ff1779176e6"
 *       },
 *       "sequence": "1703756466660667",
 *       "sourceChannel": "UNKNOWN_CHANNEL_TYPE",
 *       "targetChannels": [],
 *       "visibility": "BUSINESS_AND_PARTICIPANT",
 *     },
 *     {
 *       "_createdDate": "2023-12-27T16:16:07.816Z",
 *       "_id": "1703693767816923",
 *       "badges": [],
 *       "content": {
 *         "previewText": "Thanks for the like :)",
 *         "basic": {
 *           "items": [
 *             {
 *               "text": "Thanks for the like :)"
 *             }
 *           ]
 *         },
 *       },
 *       "direction": "BUSINESS_TO_PARTICIPANT",
 *       "sender": {
 *         "wixUserId": "b17c523c-6ec9-4b56-9d9d-123cc6978bdf"
 *       },
 *       "sequence": "1703693767816923",
 *       "sourceChannel": "UNKNOWN_CHANNEL_TYPE",
 *       "targetChannels": [
 *         "CHAT"
 *       ],
 *       "visibility": "BUSINESS_AND_PARTICIPANT",
 *     }
 *   ],
 *   "pagingMetadata": {
 *     "tooManyToCount": true
 *   }
 * }
 */


View a list of sent messages (export from backend code)

listMessages

ListMessagesResponse

ID of the conversation to add the message to.

message

Message

Additional options for sending a message.

SendMessageOptions

Sends a message to the business or participant.


Specify the message type in `message.content`
by including the appropriate object: `basic`, `template`, `minimal`, or `form`.
For more information on message types
and how each type renders in Inbox and the Chat widget,
see [Message Types](#message-types).

import { messages } from 'wix-inbox.v2';

/* Sample conversationId value: 'e56ed8f7-4bbf-3d99-b2f9-962e555264c3'
 *
 * Sample messsage value:
 * {
 *     content: {
 *       previewText: "Welcome",
 *       basic: {
 *         items: [
 *           {
 *             text: "Welcome to Amy's Shoes!"
 *           }
 *         ]
 *       }
 *     },
 *     visibility: 'BUSINESS_AND_PARTICIPANT',
 *     direction: 'BUSINESS_TO_PARTICIPANT',
 *     sourceChannel: 'CHAT',
 *     targetChannels: ['CHAT']
 * }
 */

export async function mySendMessageFunction(conversationId, message) {
  try {
    const basicMessage = await messages.sendMessage(conversationId, message);
    const messageId = basicMessage.message._id;
    const sender = basicMessage.message.sender;
    const visibility = basicMessage.message.visibility;

    return basicMessage;
  } catch (error) {
    console.error(error);
    //Handle the error
  }

}

/* Promise resolves to:
 * {
 *   "_createdDate": "2023-11-27T16:51:58.040Z"
 *   "_id": "1701103918040190",
 *   "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a",
 *   "badges": [],
 *   "content": {
 *     "previewText": "Welcome",
 *     "contentType": "BASIC"
 *     "basic": {
 *       "items": [
 *         {
 *           "text": "Welcome to Amy's Shoes!"
 *         }
 *       ]
 *     },
 *   },
 *   "direction": "BUSINESS_TO_PARTICIPANT",
 *   "sender": {
 *     "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
 *   },
 *   "sequence": "1701103918040190",
 *   "sourceChannel": "CHAT",
 *   "targetChannels": [
 *     "CHAT"
 *   ],
 *   "visibility": "BUSINESS_AND_PARTICIPANT",
 * }
 */

Send a basic message (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { messages } from 'wix-inbox.v2';
import { elevate } from 'wix-auth';

/* Sample conversationId value: 'e56ed8f7-4bbf-3d99-b2f9-962e555264c3'
 *
 * Sample messsage value:
 * {
 *     content: {
 *       previewText: "Welcome",
 *       basic: {
 *         items: [
 *           {
 *             text: "Welcome to Amy's Shoes!"
 *           }
 *         ]
 *       }
 *     },
 *     visibility: 'BUSINESS_AND_PARTICIPANT',
 *     direction: 'BUSINESS_TO_PARTICIPANT',
 *     sourceChannel: 'CHAT',
 *     targetChannels: ['CHAT']
 * }
 */

export const mySendMessageFunction = webMethod(Permissions.Anyone, async (conversationId, message) => {
  const elevatedSendMessage = elevate(messages.sendMessage);

  try {
    const basicMessage = await elevatedSendMessage(conversationId, message);
    const messageId = basicMessage.message._id;
    const sender = basicMessage.message.sender;
    const visibility = basicMessage.message.visibility;

    return basicMessage;
  } catch (error) {
    console.error(error);
    //Handle the error
  }

});

/* Promise resolves to:
 * {
 *   "_createdDate": "2023-11-27T16:51:58.040Z"
 *   "_id": "1701103918040190",
 *   "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a",
 *   "badges": [],
 *   "content": {
 *     "previewText": "Welcome",
 *     "contentType": "BASIC"
 *     "basic": {
 *       "items": [
 *         {
 *           "text": "Welcome to Amy's Shoes!"
 *         }
 *       ]
 *     },
 *   },
 *   "direction": "BUSINESS_TO_PARTICIPANT",
 *   "sender": {
 *     "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
 *   },
 *   "sequence": "1701103918040190",
 *   "sourceChannel": "CHAT",
 *   "targetChannels": [
 *     "CHAT"
 *   ],
 *   "visibility": "BUSINESS_AND_PARTICIPANT",
 * }
 */


Send a basic message (export from backend code)

import { Permissions, webMethod } from 'wix-web-module';
import { messages } from 'wix-inbox.v2';
import { elevate } from 'wix-auth';

/* Sample conversationId value: '74aa9ee1-8e36-3028-b441-57dacfbd841e'
 * 
 * Sample message value: 
 * {
 *     direction: 'BUSINESS_TO_PARTICIPANT',
 *     visibility: 'BUSINESS_AND_PARTICIPANT',
 *     content: {
 *       previewText: "JoJo, you're getting a spa day!",
 *       template: {
 *         title: "JoJo, you're getting a spa day!",
 *         imageUrl: 'https://static.wixstatic.com/media/f93e3d633e79921f14330f1911fc1139.jpg/v1/fill/w_1200,h_798,al_c,q_85,usm_0.66_1.00_0.01/f93e3d633e79921f14330f1911fc1139.webp',
 *         textLines: [
 *           "Thanks for booking with us!",
 *           "You're booked for a massage, mud bath, and facial on May 9, 2021."
 *         ],
 *         buttons: [{
 *           label: 'View My Invoice',
 *           launchUrl: 'https://static.wixstatic.com/media/f93e3d633e79921f14330f1911fc1139.jpg/v1/fill/w_1200,h_798,al_c,q_85,usm_0.66_1.00_0.01/f93e3d633e79921f14330f1911fc1139.webp'
 *         },
 *         {
 *           label: 'Change My Appointment',
 *         postbackProperties: {
 *           interactionId: 'spa_day_54321__change_appointment'
 *           }
 *         }
 *         ]
 *       }
 *     },
 *     sourceChannel: "CHAT",
 *     targetChannels: ['CHAT']
 *   }
 */

export const mySendMessageFunction = webMethod(Permissions.Anyone, async (conversationId, message) => {
  const elevatedSendMessage = elevate(messages.sendMessage);

  try {
    const templateMessage = await elevatedSendMessage(conversationId, message);

    return templateMessage;
  } catch (error) {
    console.log(error);
    //Handle the error
  }

});

/* Promise resolves to:
 * {
 *   "_createdDate": "2023-11-29T10:40:52.822Z",
 *     "_id": "1701254452822623",
 *     "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a",
 *     "badges": [],
 *      "message": {
 *        "content": {
 *          "previewText": "JoJo, you're getting a spa day!",
 *          "template": {
 *            "buttons": 
 *            [
 *              {
 *                "label": "View My Invoice",
 *                "launchUrl": "https://static.wixstatic.com/media/f93e3d633e79921f14330f1911fc1139.jpg/v1/fill/w_1200,h_798,al_c,q_85,usm_0.6 6_1.00_0.01/f93e3d633e79921f14330f1911fc1139.webp"
 *              },
 *              {
 *                "label": "Change My Appointment",
 *                "postbackProperties": 
 *                {
 *                  "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a",
 *                  "interactionId": "spa_day_54321__change_appointment"
 *                }
 *              }
 *            ],
 *          "imageUrl": "https://static.wixstatic.com/media/f93e3d633e79921f14330f1911fc1139.jpg/v1/fill/w_1200,h_798,al_c,q_85,usm_0.66_1.0 0_0.01/f93e3d633e79921f14330f1911fc1139.webp"
 *          "orientation": "PORTRAIT",
 *          "textLines": 
 *          [
 *            "Thanks for booking with us!",
 *            "You're booked for a massage, mud bath, and facial on May 9, 2021."
 *          ],
 *          "title": "JoJo, you're getting a spa day!"
 *       },
 *     },
 *     "direction": "BUSINESS_TO_PARTICIPANT",
 *       "sender": {
 *       "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
 *     },
 *     "sequence": "1701254452822623",
 *     "sourceChannel": "CHAT",
 *     "targetChannels": [],
 *      "visibility": "BUSINESS_AND_PARTICIPANT",
 *     }
 * }
 */


Send a template message  

/****************************
 * Backend code - events.js *
 ****************************/

import { sendMinimalMessage } from 'backend/inbox.web';

export function wixBlog_onPostLiked(event) {
  console.log(`New post liked with ID ${event.data.postId}`);
  const anonymousVisitorId = event.data.anonymousVisitorId;
  sendMinimalMessage(anonymousVisitorId);
}

/*******************************
 * Backend code - inbox.web.js *
 *******************************/

import { Permissions, webMethod } from 'wix-web-module';
import { conversations, messages } from 'wix-inbox.v2';
import { elevate } from 'wix-auth';

export const sendMinimalMessage = webMethod(Permissions.Anyone, async (anonymousVisitorId) => {
  const message = {
    direction: 'PARTICIPANT_TO_BUSINESS',
    visibility: 'BUSINESS',
    content: {
      previewText: 'New Like',
      minimal: {
        text: 'New Like',
        iconUrl: 'https://static.wixstatic.com/media/727514_1a58537f1b6a44a7b09956cdbc5ac774~mv2.png/v1/fill/w_297,h_324,al_c,lg_1,q_85/727514_1a58537f1b6a44a7b09956cdbc5ac774~mv2.webp'
      }
    }
  }

  try {
    const conversationId = await getOrCreateConversationIdFromVisitor(anonymousVisitorId);

    const elevatedSendMessage = elevate(messages.sendMessage);
    const minimalMessage = await elevatedSendMessage(conversationId, message);
    console.log(`The message object returned is ${minimalMessage}`);

    return minimalMessage;
  } catch (error) {
    console.error(error);
    //Handle the error
  }
});

export const getOrCreateConversationIdFromVisitor = webMethod(Permissions.Anyone, async (anonymousVisitorId) => {
  const participantId = {
    anonymousVisitorId: anonymousVisitorId
  };

  try {
    const elevatedGetOrCreateConversation = elevate(conversations.getOrCreateConversation);
    const conversationObject = await elevatedGetOrCreateConversation(participantId);

    return conversationObject.conversation._id;
  } catch (error) {
    console.error(error);
    //Handle the error
  }
});

This code detects a when a site visitor likes a blog post by registering the `onPostLiked` event listener in the `events.js` file. This event triggers an event object containing the `anonymousVisitorId`, which is  passed as an argument to `getOrCreateConversationIdFromVisitor`. The conversationId is returned and passed as a parameter to `sendMinimal`, which sends a minimal message to the site owner's inbox dashboard.

Send a minimal message to a site visitor 

/*******************************
 * Backend code - inbox.web.js *
 *******************************/

import { Permissions, webMethod } from 'wix-web-module';
import { conversations, messages } from 'wix-inbox.v2';
import { currentMember } from 'wix-members-backend'
import { elevate } from 'wix-auth';

export const sendFormData = webMethod(Permissions.Anyone, async (formData) => {
  const message = {
    direction: 'PARTICIPANT_TO_BUSINESS',
    visibility: 'BUSINESS',
    content: {
      previewText: 'New Contact',
      form: {
        title: 'New Contact',
        description: 'New Contact Form',
        fields: [
          { 
            name: 'First Name', 
            value: formData.firstName
          },
          { 
            name: 'Last Name', 
            value: formData.lastName 
          },
          { 
            name: 'email', 
            value: formData.email 
          },
          { 
            name: 'Wants Newsletter', 
            value: formData.subscribeNewsletter.toString() 
          }
        ],
      }
    }
  }
  
  try {
    const conversationId = await getOrCreateConversationIdFromMember();

    const elevatedSendMessage = elevate(messages.sendMessage);
    const formMessage = await elevatedSendMessage(conversationId, message);

    return formMessage;
  } catch (error) {
    console.error(error);
    //Handle the error
  }
});

export const getOrCreateConversationIdFromMember = webMethod(Permissions.Anyone, async () => {
  const member = await currentMember.getMember();
  const participantId = { 
    memberId: member._id 
  };
  
  try {
    const elevatedGetOrCreateConversation = elevate(conversations.getOrCreateConversation);
    const conversationObject = await elevatedGetOrCreateConversation(participantId);
    
    return conversationObject.converation._id;
  } catch (error) {
    console.error(error);
    //Handle the error
  }
});
/*************
 * Page code *
 *************/

import { sendFormData } from 'backend/inbox.web';

$w.onReady(function () {
  $w('#submitButton').onClick(async () => {
    const firstName = $w('#firstName').value;
    const lastName = $w('#lastName').value;
    const email = $w('#email').value;
    const subscribeNewsletter = $w('#subscribeNewsletter').checked;
    const dataToInsert = {
      firstName,
      lastName,
      email,
      subscribeNewsletter
    };

    const formData = await sendFormData(dataToInsert);
    console.log(`The form data is ${formData}`);
  });
});

The page code passes input values submitted by a logged-in member to the backend `sendFormData` function. This function retrieves the logged-in member ID, gets an existing or creates a new converation object and uses the conversation ID to send a form message to the site owner's inbox dashboard.

Get or create a new conversation with a member 

sendMessage

SendMessageResponse

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

or

```console
yarn add @wix/inbox
```

Then import `{ messages }` from `@wix/inbox`:

```js
import { messages } from '@wix/inbox'
```
  

inbox_messages

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 `onMessageButtonInteracted()` event when the button is clicked.

postbackProperties

PostbackProperties

ChannelType

CursorPaging

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

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

cursor

Maximum number of items to return in the results.

limit

number

Cursors

Cursor string pointing to the next page in the list of results.

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

IdentificationData

anonymousVisitorId

appId

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

width

paging

sorting

Sorting

List of messages between the specified visitor and the site.

messages

Details on the paged set of results returned.

pagingMetadata

PagingMetadataV2

MediaItem

_createdDate

For internal use. 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.

You can override the default behavior when calling
`sendMessage()` by using the `sendAs` field from the `options` object.

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.

Supported values: `"CHAT"`, `"EMAIL"`, `"SMS"`, `"FACEBOOK"`, `"INSTAGRAM"`, `"WHATSAPP"`.

sourceChannel

Communication channel to send the message to.

Currently messages can be sent to 1 channel only.

Supported values: `"CHAT"`, `"EMAIL"`, `"SMS"`, `"FACEBOOK"`, `"INSTAGRAM"`, `"WHATSAPP"`.

targetChannels

__Required.__
Controls who can see the message.

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

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

MinimalMessagePayload

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

Orientation

OverrideSenderOptions

Number of items returned in the response.

count

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

cursors

offset

Flag that indicates the server failed to calculate the `total` field.

tooManyToCount

boolean

Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.

total

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

interactionId

Controls which identity to use in the message's `sender` property.

- `CALLER`: Uses the identity of the initiator of the sent message.
- `PARTICIPANT`: Uses the `anonymousVisitorId`, `contactId`, or `memberId` of the conversation's participant.
- `BUSINESS_USER`: For internal use. Uses the `wixUserId` of the person sending messages on behalf of the business.

Default: `CALLER`.

sendAs

Controls whether the message triggers notifications when it's received.

Default: `false`.

sendNotifications

Controls whether the unread count and conversation summary
are updated in the
[Message List](https://support.wix.com/en/article/wix-inbox-getting-started#view-your-messages).

If `true`, unread count and conversation summary are not updated.

Default: `false`.

silent

SortOrder

fieldName

order

SystemMessagePayload

List of buttons to display with the message.
Buttons can either open a URL or pass interaction details to the
`onMessageButtonInteracted()` event.

Maximum: 10 buttons.

buttons

imageUrl

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

TemplateMessagePayload

List of buttons to display with the message.
Buttons can either open a URL or pass interaction details to the
`onMessageButtonInteracted()` event.

Max: 10 buttons.

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

Supported values: `"PORTRAIT"`, `"LANDSCAPE"`.

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

Setup

Permission Scopes

Permission Scopes