Salesforce Console Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
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)
Using Background Utility Items
Using Events with the Lightning Console JavaScript API
Using Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
lightning:tabClosed
lightning:tabCreated
lightning:tabFocused
lightning:tabRefreshed
lightning:tabReplaced
lightning:tabUpdated
lightning:conversationAgentSend
lightning:conversationChatEnded
lightning:conversationCustomEvent
lightning:conversationNewMessage
Newer Version Available
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
-
lightning:conversationAgentSend
Event triggered when an agent sends a chat message through the Salesforce console. This method does not intercept the message before it’s sent to the chat visitor. This event is also triggered when using Enhanced Messaging channels. -
lightning:conversationChatEnded
Event triggered when an active chat ends or an agent leaves a chat conference. This event is also triggered when using Enhanced Messaging channels. -
lightning:conversationCustomEvent
Event triggered when a custom event occurs during a chat. -
lightning:conversationNewMessage
Event triggered when the customer sends a new message. This event is also triggered when using Enhanced Messaging channels. To work with Enhanced Messaging channels, the session must be active and the Enhanced Conversation Component must be visible on the page.