Salesforce Console Developer Guide
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Summer '14 (API version 31.0)
Spring '14 (API version 30.0)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Using Background Utility Items
Using Events with the Lightning Console JavaScript API
Use Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
endChat()
getChatLog()
sendCustomEvent()
sendMessage()
Methods for Chat in Lightning Experience
Let customers chat with your agents on your web page.
Connect with customers or website visitors in real time through Web-based chat.
The legacy chat product is in maintenance-only mode, and we won't continue to build new features. You can continue to use it, but we no longer recommend that you implement new chat channels. Instead, you can modernize your customer communication with Messaging for In-App and Web. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time. For Lightning Console JavaScript API, use Aura Methods for Enhanced Messaging in Lightning Experience.
Important
-
endChat() for Lightning Experience
Ends a chat in which an agent is currently engaged. This method works only in Lightning console apps. -
getChatLog() for Lightning Experience
Returns the chat log of a chat associated with a specific recordId. This method works only in Lightning console apps. -
sendCustomEvent() for Lightning Experience
Sends a custom event to the client-side chat window for a chat with a specific chat key. This method works only in Lightning console apps. -
sendMessage() for Lightning Experience
Sends a new chat message from the agent to a chat with a specific chat key. This method works only in Lightning console apps.