Set Up Omni-Channel 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)
Omni-Channel Metadata API Types
acceptAgentWork for Lightning Experience
closeAgentWork for Lightning Experience
declineAgentWork for Lightning Experience
getAgentWorks for Lightning Experience
getAgentWorkload for Lightning Experience
getServicePresenceStatusChannels for Lightning Experience
getServicePresenceStatusId for Lightning Experience
login for Lightning Experience
logout for Lightning Experience
lowerAgentWorkFlag for Lightning Experience
raiseAgentWorkFlag for Lightning Experience
setServicePresenceStatus for Lightning Experience
lightning:omniChannelLoginSuccess
lightning:omniChannelStatusChanged
lightning:omniChannelLogout
lightning:omniChannelWorkAssigned
lightning:omniChannelWorkAccepted
lightning:omniChannelWorkDeclined
lightning:omniChannelWorkClosed
lightning:omniChannelWorkFlagUpdated
lightning:omniChannelWorkloadChanged
Newer Version Available
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.
-
lightning:omniChannelLoginSuccess
Indicates that an agent has been logged into Omni-Channel successfully. -
lightning:omniChannelStatusChanged
Indicates that an agent has changed his or her presence status in Omni-Channel. -
lightning:omniChannelLogout
Indicates that an agent has logged out of Omni-Channel. -
lightning:omniChannelWorkAssigned
Indicates that an agent has been assigned a new work item. -
lightning:omniChannelWorkAccepted
Indicates that an agent has accepted a work assignment, or that a work assignment has been automatically accepted. -
lightning:omniChannelWorkDeclined
Indicates that an agent has declined a work assignment. -
lightning:omniChannelWorkClosed
Indicates that the status of an AgentWork object is changed to Closed. -
lightning:omniChannelWorkFlagUpdated
Indicates that an agent’s work item flag has been raised or lowered. -
lightning:omniChannelWorkloadChanged
Indicates that an agent’s workload has changed. This includes receiving new work items, declining work items, and closing items in the console. It also indicates that there has been a change to an agent’s capacity or presence configuration, or that the agent has gone offline in the Omni-Channel utility.