Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

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';

async function listMessages(conversationId, visibility, options) {
  const response = await messages.listMessages(conversationId, visibility, options);
};

listMessages: Wix-hosted

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

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


async function listMessages(conversationId, visibility, options) {
  const response = await myWixClient.messages.listMessages(conversationId, visibility, 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).

listMessages: Self-hosted

listMessages

Manage Inbox Messages

Read Inbox Messages

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';

async function sendMessage(conversationId, message, options) {
  const response = await messages.sendMessage(conversationId, message, options);
};

sendMessage: Wix-hosted

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

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


async function sendMessage(conversationId, message, options) {
  const response = await myWixClient.messages.sendMessage(conversationId, message, options);
};

sendMessage: Self-hosted

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

ButtonInteracted

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

appId

ID of the participant who pressed the button.

interactedBy

IdentificationData

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

interactionId

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.

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

eventTime

eventType

The identification type and identity data.

identity

WebhooksIdentificationData

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

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

width

InteractionInfo

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

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

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.

MessageButtonInteractedEnvelope

data

metadata

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

MessageSentToBusinessEnvelope

MinimalMessagePayload

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

OnMessageButtonInteractedHandler

event

void

OnMessageSentToBusinessHandler

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

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.

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.

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.

Setup