Chat REST API Developer Guide

Overview
Getting Started with the Chat REST API
Request Headers
Your Message Long Polling Loop
Using Estimated Wait Time Instead of Queue Position for a Chat Session (Beta)
Chat REST API Resources
Create a Chat Session
Create a Chat Visitor Session
Monitor Chat Activity
ChasitorNotTyping
ChasitorSneakPeek
ChasitorTyping
ChatEnd
ChasitorIdleTimeoutWarningEvent
ChatMessage
CustomEvent
Messages
Chat REST API Messages Response Objects
AgentDisconnect
AgentNotTyping
AgentTyping
ChasitorSessionData
ChatEnded
ChatEstablished
ChatMessage
ChatRequestFail
ChatRequestSuccess
ChatTransferred
CustomEvent
NewVisitorBreadcrumb
QueueUpdate
SensitiveDataRules
MultiNoun
Customize the Chat Visitors’ Experience
Request Bodies for Chat REST API
Response Bodies for Chat REST API
Chat REST API Data Types
Status Codes and Error Responses
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

CustomEvent

Indicates a custom event was sent from an agent to a chat visitor during a chat.

Syntax

Available since release
This resource is available in API versions 29.0 and later.
Response body
CustomEven response