Salesforce Console Developer Guide
jSummer '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
Newer Version Available
Events for Lightning Console JavaScript API
Use events and handlers in your Aura components and controllers to respond to events
like workspace tabs opening, closing, or gaining focus.
-
lightning:tabClosed
Indicates that a tab has been closed. -
lightning:tabCreated
Indicates that a tab has been created successfully. -
lightning:tabFocused
Indicates a tab was focused. -
lightning:tabRefreshed
Indicates that a tab has been refreshed. -
lightning:tabReplaced
Indicates that a tab has been replaced successfully. -
lightning:tabUpdated
Indicates that a tab has been updated successfully. -
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. -
Events for Messaging
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 Messaging. These events apply to Lightning Experience only. -
Events for Omni-Channel
JavaScript can be executed when certain types of events occur in a console, such as when a user closes a tab. There are a few events that are specific to Omni-Channel. These events apply to Lightning Experience only.