Introduction

Deprecation Notice:

This API has been replaced with Inbox and will be removed on September 30, 2022.

Wix Chat allows Wix site owners to communicate with their site visitors through a chatbox installed on their website.

Important: The Wix Chat API is incomplete.

With the Wix Chat API, you can:

  • Listen for new messages from site visitors
  • Send messages to site visitors (the site owner will have access to these messages via the Wix Inbox)
Was this helpful?
Yes
No

Code Send Message Object

Was this helpful?
Yes
No
post

Send Message

Sends a text message to a specific channel (AKA chat) on behalf of the site owner.

Deprecation Notice:

This endpoint has been replaced with Send Message (Inbox API) and will be removed on September 30, 2022.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Chats
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/chat/api/v1/inbox-chat/messaging/send-message
Was this helpful?
Yes
No

Message Received

Triggered when a message is received.

Deprecation Notice:

This webhook has been replaced with the Message Sent to Business Webhook and will be removed on September 30, 2022.

Permissions

WIX_CHAT.READ_MESSAGES
Learn more about permissions.

Event Body

Event Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.

Event Data

sequence
integer
READ ONLY
Incremental ID (used for ordering & tracking)
channelId
string
Channel ID (AKA Chat ID)
type
string
1 supported values:

TEXT,

Message type
summary
string
One-line summary of the message, as displayed in the site owner's chat view
participantId
string
READ ONLY
Participant ID that sent this message
createdDate
string
READ ONLY
format date-time
.
Creation date
metadata
object
format map
.
Any extra data that is valuable for this message
payload
object
Message payload
sender
object
Message sender
direction
string
READ ONLY
2 supported values:

BusinessToVisitor, VisitorToBusiness,

Message direction
Was this helpful?
Yes
No