Live agent chat context variables
Use chat context variables to pass certain information from the topic to share with a live agent or to control how bot conversations are routed to live agents. Virtual Agent includes some default variables, and you can define new ones.
Note: The Interaction table is part of the interaction management framework, which is activated through the Interactions Management plugin (com.glide.interaction). This plugin is included with the Agent Chat (com.glide.interaction.awa) and Connect Support (com.glide.connect.support) plugins.
|
Variable |
Description |
|---|---|
|
application |
Application scope of the chat. For example, Global, HR, CSM, or ITSM. |
|
case |
Case ID (from the [sn_customerservice_case] table) that is used with the Customer Service Management application when a case is related to the chat. |
|
csp_category |
Category defined in the Consumer Service portal in the CSM application (requires the com.glide.service-portal.consumer-portal plugin). For more information, see Using the Consumer Service Portal. |
|
devicetype |
Type of device being used for the chat. For example, mweb (chat widget), android, or ios. |
|
hr_topic_id |
ID of the current topic. Used in Advanced Work Assignment to determine which HR queue to transfer the user for live agent chat. |
|
interaction_account |
Used with CSM chats that are initiated by B2B users who are tracked as contacts for a particular account. Corresponds with the Account field on the Interaction [interaction] table, which references the Accounts [customer_account] table. |
|
interaction_consumer |
Used with CSM chats that are initiated by B2C users who are tracked as consumers. Matches the interaction.consumer field referencing the csm_consumer table. Corresponds with the Consumer field on the Interaction [interaction] table, which references the Consumers [csm_consumer] table. |
|
interaction_contact |
Used with CSM chats that are initiated by B2B users who are tracked as contacts for a particular account. Corresponds with the Contact field on the Interaction [interaction] table, which references the Contacts [customer_contact] table. |
|
interaction_id |
Sys_id of the interaction record associated with the chat session.For more information, see Virtual Agent interaction records. |
|
language |
Two-letter language code for the requester's chat.Note: Language values use ISO standard two-character language codes. For more information, see ISO 639.1 language codes. |
|
mandatory_skills |
Required skills and skill level for an agent.For example, German language proficiency with an associated high skill level may be required for German-speaking requesters. You can define mandatory skills and activate skill levels in Advanced Work Assignment. For more information, see Configure agent assignment rules. |
|
optional_skills |
Skills and skill levels that would be useful for a given chat scenario.You can define optional skills in Advanced Work Assignment. For more information, see Configure agent assignment rules. |
|
page |
The specific page (within a portal) that the chat was accessed from. |
|
portal |
Name of the portal that the chat was accessed from. |
|
search_text |
Search terms entered by the requester. Used to search Virtual Agent topics. |
|
short_description |
Used to set the short description in the interaction record associated with the chat. |
|
sys_id |
Sys_id of a record that relates to the interaction. Typically, this is the record being viewed in the portal when the chat is requested. |
|
table |
Table containing the record that relates to the interaction. Typically, this is the record being viewed in the portal when the chat is requested. |
- How to transfer a chat to a specific queue using context variables
- Virtual Agent and Natural Language Understanding (NLU) community forum
- Conversational Interfaces Academy
Parent Topic:Configure context variables for storing chat-related information
--- title: Live agent chat context variables description: Use chat context variables to pass certain information from the topic to share with a live agent or to control how bot conversations are routed to live agents. Virtual Agent includes some default variables, and you can define new ones. locale: en-US canonical_url: https://www.servicenow.com/docs/r/australia/conversational-interfaces/live-agent-chat-context-vars.html release: australia product: Conversational Interfaces classification: conversational-interfaces topic_type: reference last_updated: "2026-09-10" reading_time_minutes: 3 keywords: [Live Agent, chat, context, variables, Virtual Agent, Interaction, Connect Support] breadcrumb: [Configure context variables, General chat settings, Configuring Conversational Interfaces, Conversational Interfaces Console, Conversational Interfaces] --- # Live agent chat context variables Use chat context variables to pass certain information from the topic to share with a live agent or to control how bot conversations are routed to live agents. Virtual Agent includes some default variables, and you can define new ones. **Note:** The Interaction table is part of the interaction management framework, which is activated through the Interactions Management plugin \(com.glide.interaction\). This plugin is included with the Agent Chat \(com.glide.interaction.awa\) and Connect Support \(com.glide.connect.support\) plugins. <table id="table_urp_2tg_rpb"><thead><tr><th> Variable </th><th> Description </th></tr></thead><tbody><tr><td> application </td><td> Application scope of the chat. For example, **Global**, **HR**, **CSM**, or **ITSM**. </td></tr><tr><td> case </td><td> Case ID \(from the \[sn\_customerservice\_case\] table\) that is used with the Customer Service Management application when a case is related to the chat. </td></tr><tr><td> csp\_category </td><td> Category defined in the Consumer Service portal in the CSM application \(requires the com.glide.service-portal.consumer-portal plugin\). For more information, see [Using the Consumer Service Portal](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/customer-service-management/use-consumer-service-portal.md). </td></tr><tr><td> devicetype </td><td> Type of device being used for the chat. For example, **mweb** \(chat widget\), **android**, or **ios**. </td></tr><tr><td> hr\_topic\_id </td><td> ID of the current topic. Used in Advanced Work Assignment to determine which HR queue to transfer the user for live agent chat. </td></tr><tr><td> interaction\_account </td><td> Used with CSM chats that are initiated by B2B users who are tracked as contacts for a particular account. Corresponds with the **Account** field on the Interaction \[interaction\] table, which references the Accounts \[customer\_account\] table. </td></tr><tr><td> interaction\_consumer </td><td> Used with CSM chats that are initiated by B2C users who are tracked as consumers. Matches the interaction.consumer field referencing the csm\_consumer table. Corresponds with the **Consumer** field on the Interaction \[interaction\] table, which references the Consumers \[csm\_consumer\] table. </td></tr><tr><td> interaction\_contact </td><td> Used with CSM chats that are initiated by B2B users who are tracked as contacts for a particular account. Corresponds with the **Contact** field on the Interaction \[interaction\] table, which references the Contacts \[customer\_contact\] table. </td></tr><tr><td> interaction\_id </td><td> Sys\_id of the interaction record associated with the chat session.For more information, see [Virtual Agent interaction records](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/conversational-interfaces/virtual-agent/va-interactions.md). </td></tr><tr><td> language </td><td> Two-letter language code for the requester's chat.**Note:** Language values use ISO standard two-character language codes. For more information, see [ISO 639.1 language codes](http://www.loc.gov/standards/iso639-2/php/code_list.php). </td></tr><tr><td> mandatory\_skills </td><td> Required skills and skill level for an agent.For example, German language proficiency with an associated high skill level may be required for German-speaking requesters. You can define mandatory skills and activate skill levels in Advanced Work Assignment. For more information, see [Configure agent assignment rules](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/conversational-interfaces/advanced-work-assignment/awa-create-assignment-rule.md). </td></tr><tr><td> optional\_skills </td><td> Skills and skill levels that would be useful for a given chat scenario.You can define optional skills in Advanced Work Assignment. For more information, see [Configure agent assignment rules](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/conversational-interfaces/advanced-work-assignment/awa-create-assignment-rule.md). </td></tr><tr><td> page </td><td> The specific page \(within a portal\) that the chat was accessed from. </td></tr><tr><td> portal </td><td> Name of the portal that the chat was accessed from. </td></tr><tr><td> search\_text </td><td> Search terms entered by the requester. Used to search Virtual Agent topics. </td></tr><tr><td> short\_description </td><td> Used to set the short description in the interaction record associated with the chat. </td></tr><tr><td> sys\_id </td><td> Sys\_id of a record that relates to the interaction. Typically, this is the record being viewed in the portal when the chat is requested. </td></tr><tr><td> table </td><td> Table containing the record that relates to the interaction. Typically, this is the record being viewed in the portal when the chat is requested. </td></tr></tbody> </table>## Additional resources - [How to transfer a chat to a specific queue using context variables](https://www.servicenow.com/community/virtual-agent-nlu-articles/how-to-transfer-a-chat-to-a-specific-queue-using-context/ta-p/2307392) - [Virtual Agent and Natural Language Understanding \(NLU\) community forum](https://community.servicenow.com/community?id=community_forum&sys_id=bf5abf94db54e3c42be0a851ca961915) - [Conversational Interfaces Academy](https://www.servicenow.com/community/virtual-agent-nlu-articles/conversational-interfaces-academy-live-builds-and-q-amp-a-join/ta-p/2345155) **Parent Topic:**[Configure context variables for storing chat-related information](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/conversational-interfaces/ac-configure-context-variables.md)
| title | Live agent chat context variables |
| description | Use chat context variables to pass certain information from the topic to share with a live agent or to control how bot conversations are routed to live agents. Virtual Agent includes some default variables, and you can define new ones. |
| locale | en-US |
| canonical_url | https://www.servicenow.com/docs/r/australia/conversational-interfaces/live-agent-chat-context-vars.html |
| release | australia |
| product | Conversational Interfaces |
| classification | conversational-interfaces |
| topic_type | reference |
| last_updated | 2026-09-10 |
| reading_time_minutes | 3 |
| keywords | Live AgentchatcontextvariablesVirtual AgentInteractionConnect Support |
| breadcrumb | Configure context variablesGeneral chat settingsConfiguring Conversational InterfacesConversational Interfaces ConsoleConversational Interfaces |