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?
Code Send Message Object
Was this helpful?
PostSend 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-messageWas this helpful?
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.
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
sequenceintegerRead-only
Incremental ID (used for ordering & tracking)
channelIdstring
Channel ID (AKA Chat ID)
typestring
1 supported values:
TEXT
Message type
summarystring
One-line summary of the message, as displayed in the site owner's chat view
participantIdstringRead-only
Participant ID that sent this message
createdDatestringRead-onlyformat date-time
Creation date
metadataobjectformat map
Any extra data that is valuable for this message
payloadobject
Message payload
senderobject
Message sender
directionstringRead-only
2 supported values:
BusinessToVisitorVisitorToBusiness
Message direction
Was this helpful?