Link syntax

To open a Help Desk Chat queue from a custom link on the ESS Portal, you must call the CustomEvent.fire method using appropriate arguments.

To open a Help Desk Chat queue from a custom link on the ESS Portal, you must call the CustomEvent.fire method using appropriate arguments. Details of the API call and an example that generates an anchor link are provided below.

API Call:

CustomEvent.fire(LiveEvents.LIVE_EVENT, LiveEvents.LIVE_WINDOW_JOIN_QUEUE_QUERY, CHAT_QUEUE_SYS_ID, CHAT_QUEUE_SYS_NAME);
where the variables are:
  • CHAT_QUEUE_SYS_ID: Specifies the sys_id for the chat queue.
  • CHAT_QUEUE_SYS_NAME: Specifies the name of the chat queue (must match the value the Name field of the chat queue record).

Example: This example creates an anchor link that opens the Help Desk Chat queue.

<a href="#" onclick="CustomEvent.fire(LiveEvents.LIVE_EVENT,
                                      LiveEvents.LIVE_WINDOW_JOIN_QUEUE_QUERY,
                                      'c54f0abf0a0a0b452db84664f409c79c',
                                      'Help Desk Chat'); return false;">
  Help Desk Chat
</a>