Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
How are the Classic and Lightning Console APIs Different?
Lightning Console JavaScript API
Lightning Console JavaScript API Syntax
Using Background Utility Items
Using Pop-Out Utilities
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
Methods
Events
lightning:tabClosed
lightning:tabCreated
lightning:tabFocused
lightning:tabRefreshed
lightning:tabReplaced
lightning:tabUpdated
Lightning Message Channels for LWC
LWC Events for Enhanced Messaging
Aura Events for Enhanced Messaging
Events for Chat
lightning:conversationAgentSend
lightning:conversationChatEnded
lightning:conversationCustomEvent
lightning:conversationNewMessage
Events for Omni-Channel
Salesforce Classic API
Other Resources
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.

Events for Chat

JavaScript can be executed when certain types of events occur in a console, such as when a user closes a tab. A few events are specific to Chat. These events apply to Lightning Experience only.

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 Lightning Web Component Events for Enhanced Messaging or Aura Events for Enhanced Messaging.

Important