Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

An object representing the message to be sent.

messageInfo

MessageInfo

Sends a chat message from the backend.

The `sendMessage()` function sends a text message to a specific channel from
 the backend. The message can be from the business to a visitor, or from a
 visitor to the business.

import wixChatBackend from 'wix-chat-backend';

 export function sendChatMessage(messageText, channelId, metadata, sendAsVisitor) {
   wixChatBackend.sendMessage({
     "messageText": messageText,
     "channelId": channelId,
     "metadata": {metadata},
     "sendAsVisitor": sendAsVisitor
   })
   .then( () => {
     console.log("Chat message sent");
   })
   .catch( (error) => {
     console.log(error);
   });
 }

Send a chat message from the backend

/*************
 * page code *
 *************/
import { sendChatMessage } from 'backend/chat';
import wixWindow from 'wix-window';

// ...

export async function sendMessageButton_click(event) {
  const channel = await $w("#myChatbox").getChannel({ type: "Business" });
  const channelId = channel.id;

  const messageText = $w('#textInput').value;
  const sendAsVisitor = "true";

  sendChatMessage(messageText, channelId, sendAsVisitor);
}

/****************************
 * Backend code - chat.jsw *
 ****************************/
import wixChatBackend from 'wix-chat-backend';

export function sendChatMessage(messageText, channelId, sendAsVisitor) {
  wixChatBackend.sendMessage({
    "messageText": messageText,
    "channelId": channelId,
    "sendAsVisitor": sendAsVisitor
  })
}

/**********************************
 * Backend event code - events.js *
 **********************************/
export function wixChat_onMessage(event) {
  const chatMessage = event.payload.text;
  const chatParticipant = event.participantId;
}

/*  Example SendMessageEvent object:
 *
 *  {
 *    "channelId": "23b345b6-c78d-9012-e3f4-567g89h0i01k",
 *    "type": "TEXT",
 *    "summary": "Hey, I've got a question about your products",
 *    "participantId": "12a345b6-e78f-8011-f3f5-567g89h0i12j",
 *    "direction": "VisitorToBusiness",
 *    "createdAt": "2019-10-27T06:02:12.008Z",
 *    "payload": {
 *      "text": "Hey, I've got a question about your products"
 *    },
 *    "metadata": {}
 *  }
 */


In this example, we use an input element to get the text of a chat message from a site visitor.
 We get the business channel ID and send the chat message to the business.

Get message text from an input element and send it as a chat message

sendMessage

void

# Introduction
Using the backend Chat API, site owners and contributors (referred to as the site's "business")
can exchange chat messages with site members, contacts, and visitors (referred to as "visitors").

The backend Chat API is not applicable to social chat. For social chat between site members, use the [client-side Chat API]($w.Chatbox.html).

**Note:**

You cannot use a channel programmatically until it is created. A channel is created the first time the business or a visitor sends a message via the chatbox widget to a specific recipient.


 To use the Chat API, import `wixChat` from the `wix-chat-backend` module:

   ```javascript
   import wixChatBackend from 'wix-chat-backend';

  ```

velo_wix-chat-backend

An event that fires when a chat message is sent to or from the business.

The `onMessage()` event handler runs when a backend chat message is sent to or from the business. The received `SendMessageEvent`
 object contains information about the message that was sent.
> **Note:** Backend events don't work when previewing your site.

onMessage

# Introduction
Wix Chat events are fired on your site's backend when certain events related to the [Wix Chat](https://support.wix.com/en/article/about-wix-chat) application occur.
 You can write event handlers that react to these events. Event handler functions
 receive data that corresponds to the event that fired. Use event handlers
 to create custom responses to chat message events.

 To add a chat event handler, add an **events.js** file to the **Backend** section
 of your site if one does not already exist. All event handler functions for your
 site are defined in this file.

 Event handler functions are defined using the following pattern:

 ```javascript
 export function <wixAppName>_<eventName>(event) { }
 ```

 For example, an event handler that handles backend chat messages looks
 like this:

 ```javascript
 export function wixChat_onMessage(event) { }
 ```

 Note that backend events don't work when previewing your site.

Events

MessagePayload

text

string

SendMessageEvent

ID of the channel on which the message was sent.

channelId

createdAt

Direction of the message.
One of the following:

 + `"VisitorToBusiness"`: From a site visitor to the business.
 + `"BusinessToVisitor"`: From the business to a site visitor.

direction

An object representing additional contextual message information included in a chat message. The site visitor does not see the metadata.

metadata

object

The sender's member ID. For a message sent from the site's business, the site owner's member ID.

participantId

Content of the message.
Currently only content of type text is included in the `payload`.

payload

First 250 characters of the chat message. Currently only text is included in the summary.

summary

Type of message. Currently only `TEXT` is supported.

type

The ID of the channel to send the message to. Currently only IDs of business channels are supported.

messageText

Indicates whether the message is sent from the visitor to the business. If `sendAsVisitor` is `true`, the message is sent from the site visitor to the business. If `sendAsVisitor` is `undefined` or `false`, the message is sent from the business to the site visitor. The default is `undefined`.

sendMessage( )