Skip to content

Virtual Agent technical reference › Virtual Agent reference › Virtual Agent › Conversational Interfaces

Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Virtual Agent URL parameters

Virtual Agent provides various system parameters that admins can add to an instance URL to control how page content is rendered.

Virtual Agent URL structure

You can control the page rendered for an instance by adding URL parameters to the instance URL, which is https://<instancename>.service-now.com.

The Virtual Agent chat widget is supported for use in portals or embedded in third-party pages. The following system parameters control the conversation content rendered in the Virtual Agent chat widget.

Parameter	Description	Example
sysparm\_branding\_key	Applies a chat branding configuration to the web chat client. Value: branding key for the configuration	- Apply the branding configuration to a destination page:`https://.service-now.com/$sn-va-web-client-app.do?sysparm_branding_key=` - Apply the branding configuration to an embedded chat widget: `https://.service-now.com/$sn-va-web-client-app._embed.do?sysparm_branding_key=`
sysparm\_default\_topic	Sets the default topic on launch via topic `sys_ID`.	`https://.service-now.com/$sn-va-web-client-app.do?sysparm_default_topic=`
sysparm\_domain\_id	Restricts the chat to the specified sys ID for a domain.	`https://.service-now.com/$sn-va-web-client-app.do?sysparm_domain_id=`
sysparm\_live\_agent\_only	Takes user directly to a live agent, if available.	`https://.service-now.com/$sn-va-web-client-app._embed.do?sysparm_live_agent_only=true`
sysparm\_load\_active\_only	Loads the current active conversation.Values: true: Loads only the active conversation false: Doesn't load active conversations Note: If the sysparm_skip_load_history and sysparm_load_active_only parameters are both set to true, the existing sysparm_skip_load_history parameter takes precedence.	`https://.service-now.com/$sn-va-web-client-app.do?sysparm_load_active_only=true`
sysparm\_search\_text	Sets the search text for the conversation.	`https://.service-now.com/$sn-va-web-client-app.do?sysparm_search_text=`For example, <search\_text> is request&laptop.
sysparm\_skip\_load\_history	Skips the previous message history and starts a new conversation.Values: true: Doesn’t load message history false: Loads message history Note: If the sysparm_skip_load_history parameter is set to false and the sysparm_load_active_only is set to true, the sysparm_load_active_only loads the current active conversation.	`https://.service-now.com/$sn-va-web-client-app.do?sysparm_skip_load_history=true`
sysparm\_ preview\_mode	Displays the conversation in test mode.	`https://.service-now.com/$sn-va-web-client-app.do?sysparm_preview_mode=true`
sysparm\_requester\_session\_language	Specifies the requester's language for the conversation session when Dynamic Translation for Virtual Agent is installed and configured.	`https://.service-now.com/$sn-va-web-client-app.do?sysparm_requester_session_language=` Parent Topic:Virtual Agent technical reference Related topics Domain separation and Virtual Agent Virtual Agent interaction records Virtual Agent scripts Input data types in Virtual Agent topics NLU system entities Latency feedback in Virtual Agent sndocs is an independent community mirror and is not affiliated with or endorsed by ServiceNow. ServiceNow, the ServiceNow logo, Now, and other ServiceNow marks are trademarks and/or registered trademarks of ServiceNow, Inc., in the United States and/or other countries. Other company and product names may be trademarks of the respective companies with which they are associated. © 2026 ServiceNow, Inc. All rights reserved. Documentation content is redistributed under the Apache License 2.0 from the ServiceNowDocs repository.