---
sourceDocument: Australia Conversational Interfaces
sourceDocumentLink: https://www.servicenow.com/docs/r/australia/conversational-interfaces

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia Conversational Interfaces

ft:clusterId :

    - convint

bundleId :

    - convint

workflow :

    - Platform


---

# Adding Virtual Agent to your web page

# Use the portable chat widget to add Virtual Agent to your web page {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of Use the portable chat widget to add Virtual Agent to your web page

The portable chat widget enables ServiceNow customers to easily embed the Virtual Agent chat functionality into third-party web pages, Service Portal, or UI Builder portals.
This new Seismic component streamlines configuration and supports a simpler single sign-on (SSO) authentication flow while maintaining existing system parameters and context variable compatibility.
Show full answer Show less  

## Prerequisites

* The third-party website must share the same parent domain as your ServiceNow instance for the embedded iframe to function properly.
* If embedding on subdomains outside your instance's domain, you must use a custom instance URL.
* Activate the **custom URL plugin (com.snc.customurl)** in your instance, and register the custom URL you have purchased.

## SSO Authentication

* SSO can be triggered from the chat widget only if your instance and hosting site use the same external SSO provider.
* Configure SSO by creating a JavaScript script that specifies authentication conditions and redirects users appropriately.
* Set allowed redirect URLs in the **com.glide.cs.webclientloginredirecturls** system property.
* Configure security policies via system properties **com.glide.cs.embed.cspframeancestors** and **com.glide.cs.embed.xframeoptions** (the latter for IE11) to ensure safe iframe embedding and mitigate clickjacking risks.

## Configuration and Usage

* Do not use the pages `/$sn-va-web-client-app.do?` or `/snvawebclientappembed.do` standalone; instead, follow Virtual Agent URL parameters guidance for correct embedding.
* Add the portable Virtual Agent chat widget code to your third-party web page to enable chat functionality.
* The widget uses an inline frame (iframe) to load the chat interface.
* SSO can be optionally enabled to authenticate guest users automatically when using the chat widget.
* The Content Management System (CMS) application does not support Virtual Agent embedding via this widget.

## What to Expect

By implementing the portable chat widget, ServiceNow customers can seamlessly integrate Virtual Agent chat into external web environments with simplified configuration, consistent context handling, and optional SSO support. Proper security configurations ensure safe embedding across modern and legacy browsers, enhancing user experience while protecting against clickjacking.  
The portable chat widget can run on third-party web pages, in the service portal, or in UI Builder portals.
The portable chat widget is a new Seismic component that makes it easy to add Virtual Agent chat to your page. It simplifies configuration and provides the following features:

* Easily configurable
* Simpler single sign-on (SSO) authentication flow
* Connect to Service Portal Agent Chat
* System parameters and context variables work the same as before  
  Note:  
  Do not use /$sn-va-web-client-app.do? or /sn_va_web_client_app_embed.do as a standalone page configuration. Instead, refer to the information in [Virtual Agent URL parameters](https://www.servicenow.com/docs/Zzv~gp8lB14KLBvnxx7KXQ "Virtual Agent provides various system parameters that admins can add to an instance URL to control how page content is rendered.") for how to embed the Virtual Agent chat widget successfully.
{#use-portable-va-web-client__ul_pl5_ndk_ktb}

## Prerequisites for using the portable Virtual Agent chat widget {#use-portable-va-web-client__section_q4m_3qp_r5b}

The portable chat widget uses an inline frame element (iframe). The third-party website must be under the same parent domain as your ServiceNow® instance. For example, site1.company.com and site2.company.com share the same parent domain. If you're embedding the chat widget on any subdomain that is
not shared with your ServiceNow instance, the URL must be a custom instance URL. Due to increased browser security, the chat widget may fail to load if you don't use a custom URL.  
Before you begin, do the following:

1. [Activate the custom URL plugin
   (com.snc.customurl) in your instance.](https://www.servicenow.com/docs/access?context=activate-custom-url-plugin&version=australia&pubname=australia-platform-security&ft:locale=en-US)
2. [Add the custom URL (that you previously
   purchased and registered) to your instance.](https://www.servicenow.com/docs/access?context=configure-custom-url&version=australia&pubname=australia-platform-security&ft:locale=en-US)
{#use-portable-va-web-client__ol_mtc_4kp_ktb}  
Note:  
To learn more about using custom URLs, see [Associating custom URLs to your
instance](https://www.servicenow.com/docs/access?context=custom-url&version=australia&pubname=australia-platform-security&ft:locale=en-US).

## Using SSO authentication with the portable Virtual Agent chat widget {#use-portable-va-web-client__section_bbj_tsp_r5b}

After you embed the Virtual Agent client, you can optionally trigger SSO authentication from the chat widget, but only when your instance is set up to use an external SSO provider. Your hosting site must also use the same SSO
provider as your instance. For details on setting SSO providers, see [External single sign-on (SSO)](https://www.servicenow.com/docs/access?context=c_MultipleProviderSingleSignOn&version=australia&pubname=australia-platform-security&ft:locale=en-US).

To trigger SSO authentication, create a JavaScript script that defines conditions for running authentication and redirects users to a chat widget page that you specify. You also specify the allowed URLs that can be passed in
this script, by identifying them in the com.glide.cs.web_client_login_redirect_urls system property. Specify the full redirect URLs or the host part of the URL, such as
<kbd class="ph userinput">https://example.com</kbd>.  
This procedure requires that you set values for the following two system properties:

* com.glide.cs.embed.csp_frame_ancestors
* com.glide.cs.embed.xframe_options (IE 11 only)

{#use-portable-va-web-client__ul_awd_xsp_r5b}These properties determine the security policy for the embedded chat widget, namely how browsers render and secure HTML content for Virtual Agent and Live Agent chat, in an iframe, before you embed the web chat client. The HTTP header directives that you specify tell the browser whether a page can be embedded on certain domains to mitigate clickjacking attempts. Setting both properties ensures that there are security directives for major browsers and also older browsers, such as Internet Explorer.  
Note:  
If you're using the Content Management System (CMS) application to create custom interfaces for the ServiceNow AI Platform and ServiceNow® applications, be aware that it does not support Virtual Agent.
* **[Configure the portable Virtual Agent chat widget](https://www.servicenow.com/docs/SHj8hKV9ec2GA8pKJR_tsA)**   
  Configure the portable Virtual Agent chat widget to run Virtual Agent on third-party web pages.
* **[Add the portable Virtual Agent chat widget to a third-party website](https://www.servicenow.com/docs/SnH460uvso~LSbgUuuoXdw)**   
  To use the portable chat widget for Virtual Agent on third-party web pages, add the necessary code to your web page.
* **[Embed the Virtual Agent chat widget in an external web page (legacy method for standard chat)](https://www.servicenow.com/docs/bE4NBNsIfA7byU6RzTSHew)**   
  Load the Virtual Agent chat widget interface in an external web page by using an inline frame element (iframe). You can also optionally enable the single sign-on (SSO) authentication process to run automatically for guest users who are using the chat widget and are not logged in.

**Related tasks**   

* [Configure the portable Virtual Agent chat widget](https://www.servicenow.com/docs/SHj8hKV9ec2GA8pKJR_tsA "Configure the portable Virtual Agent chat widget to run Virtual Agent on third-party web pages.")
* [Add the portable Virtual Agent chat widget to a third-party website](https://www.servicenow.com/docs/SnH460uvso~LSbgUuuoXdw "To use the portable chat widget for Virtual Agent on third-party web pages, add the necessary code to your web page.")

