> ## Documentation Index
> Fetch the complete documentation index at: https://koreai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuring the ServiceNow Agent - Utah and Higher Versions

The ServiceNow Agent integration allows you to hand off AI Agent conversations to live agents on ServiceNow. This guide covers configuration for **Utah**, **Vancouver**, and higher versions.

***

## Configuration Steps

* [Step 1: Retrieve the ServiceNow Instance URL](#step-1-retrieve-the-servicenow-instance-url)
* [Step 2: Enable the ServiceNow Agent](#step-2-enable-the-servicenow-agent)
* [Step 3: Install Required Plugins](#step-3-install-the-required-plugins)
* [Step 4: Assign Agent Roles to the Consumer Service Support Group](#step-4-assign-agent-roles-to-the-consumer-service-support-group)
* [Step 5: Update the Webhook Endpoint and Enable the Integration](#step-5-update-the-webhook-endpoint-and-enable-the-integration)
* [Step 6: Testing Configuration](#step-6-testing-configuration)

***

### Step 1: Retrieve the ServiceNow Instance URL

1. Log in to your ServiceNow account with admin credentials. The URL follows the format: `https://devXXX67.service-now.com`.
2. Copy the Instance URL for use in Step 2.

### Step 2: Enable the ServiceNow Agent

1. Log in to the Platform.

2. Select the AI Agent to configure.

3. Navigate to **App Settings > Integrations > Agent Transfer** and click **ServiceNow**.

4. On the **Configurations** tab, choose an authentication method:

   **Option 1: Basic Auth**

   ![Basic Auth](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img2.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=132092e5177995a508db0cc48a6ad1a1)

   1. Select **Agent Chat (Supported for Utah and higher versions)**.
   2. Select **Basic Auth**.
   3. Enter:

      | Field | Description |
      | - | - |
      | Instance URL | ServiceNow instance URL (for example, `https://devXXX67.service-now.com`) |
      | User Name | ServiceNow account username |
      | Password | ServiceNow account password |
      | Queue ID | Unique queue identification number |
      | Webhook URL | Web URL for custom application function callbacks |

   **Option 2: OAuth with Refresh Token**

   Follow [this ServiceNow documentation](https://support.servicenow.com/kb?id=kb_article_view\&sysparm_article=KB0778194) to generate a refresh token.

   ![OAuth with Refresh Token](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img3.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=4709050bdb7f151a6c10c3fd3437466e)

   1. Select **Agent Chat (Supported for Utah and higher versions)**.
   2. Select **OAuth with Refresh Token**.
   3. Enter:

      | Field | Description |
      | - | - |
      | Instance URL | ServiceNow instance URL |
      | Client ID | Client ID from your ServiceNow application |
      | Client Secret | Client secret from your ServiceNow application |
      | Refresh Token | Refresh token generated per the documentation |
      | Webhook URL | Web URL for custom application function callbacks |

5. Click **Authorize** to authenticate.

6. To make ServiceNow the default agent, enable **Default Agent System for all AI Agent channels**.

   > [!NOTE]
   >
   > This option is enabled only when multiple agents are configured.

7. Click **Configure** to map channels.

   ![Customize channel mapping](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img4.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=704e16d8bb691e66fe5f6ff627998558)

8. Select channels to map to the ServiceNow agent.

   ![Map channels with ServiceNow agent](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img5.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=705211b96255f9ce6a298c1add8d22cd)

9. Click **Done**, then **Save**.

10. Publish the app. See [Publishing your App](https://koreai.mintlify.site/ai-for-service/deployment/publishing-app).

### Step 3: Install the Required Plugins

1. Log in to the ServiceNow Developer instance with admin credentials.

2. Navigate to **System Definition > Plugins** from the left menu.

   ![System Definition - Plugins](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img6.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=5924ab56b96ea44fb098e1bae0214d14)

3. Search and install the following plugins:

   * **Omni-experience Standard Feature Set**

     ![Omni-experience Standard Feature Set](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img7.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=19dcc183208519aabf93eb60edc6a7f4)

   * **Advanced Work Assignment**

     ![Advanced Work Assignment](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img8.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=d119193f4662fb593341c69128343250)

   * **Customer Service Management**

     ![Customer Service Management](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img9.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=3321fda02abecda6cde3b767636f7045)

   * **Glide Virtual Agent**

     ![Glide Virtual Agent](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img10.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=e7cebbdc1171014e0849c96aba652ca8)

   * **Virtual Agent API**

     ![Virtual Agent API](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img11.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=05c5b11b70e19b928b16bd33f6553aa0)

4. Verify all plugins are installed with required permissions.

### Step 4: Assign Agent Roles to the Consumer Service Support Group

1. Log in to the ServiceNow Developer instance with admin credentials.

2. Navigate to **Advanced Work Assignment > Management > Groups**.

   ![Groups](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img12.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=b0e090cbbd0b74298374566c7989b995)

3. Select the **Consumer Service Support** group.

   ![Group details](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img13.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=75b067b401517d0979a6d388a1372b30)

4. Select the **Roles** tab and click **Edit**.

   ![Navigate to Roles screen](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img14.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=00d4b8bfbef0ec20b52789849473be53)

5. Search for and assign the **awa\_agent** and **agent\_workspace\_user** roles to the Consumer Service Support group. Click **Save**.

   ![Assign roles](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img15.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=177e156722082a4482aa136e6b02997b)

6. Go back to the group details screen, select **Group Members**, click **Edit**, and navigate to **Edit Members**.

   ![Edit members](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img16.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=1e40ed72b9d72cfb0e2e7b69eebfec10)

7. Search for and assign the required user (for example, `Abel Tuter`) to the Consumer Service Support group. Click **Save**.

   ![Assign user to group](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img17.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=3301c3a252f8b2402070be2d91ee31d9)

8. Click **Update** on the group details screen.

   ![Group details - Update](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img18.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=525ec1ed941759c884980b3e8571f5b5)

### Step 5: Update the Webhook Endpoint and Enable the Integration

1. Log in to the ServiceNow instance.

2. Navigate to **System Web Services > Outbound > REST messages**.

   ![REST messages](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img19.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=8cd22a02f4549bcc4403dc0997c8caf5)

3. Select **VABot to Bot** from the list.

   ![VABot to Bot](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img20.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=d5702621a529ae3e373a0d76cb80acbb)

4. Copy the **Webhook URL** from the **Configuration** tab of the ServiceNow Agent page.

5. Paste it into the **EndPoint** field on the VABot to Bot edit screen.

   ![Endpoint - Webhook URL](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img21.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=19bf35d341e530dbb9522899b5c63eed)

6. Scroll down, select **HTTP methods**, update the Webhook URL for **postMessage**, and click **Update**.

   ![HTTP Method - postMessage](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img22.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=0e08aba5733a112444672f7efdc49afb)

7. Click **Save** to enable the integration.

### Step 6: Testing Configuration

1. Open the AI Agent with ServiceNow enabled.

2. Create an Agent Transfer Node task (for example, `Platform Agent` task with a `UserAgent` node). See [Agent Transfer Node](https://koreai.mintlify.site/ai-for-service/automation/dialogs/node-types/agent-transfer-node).

   ![Agent Transfer Node task](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img23.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=4b4293e68d32446747a9e4623063c26c)

3. Click **Talk to Bot** and enter **Help**.

4. Log in to ServiceNow, go to **Profile**, and select **Impersonate User**.

   ![Impersonate user](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img24.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=b1f6a7e2732b7b2a7d393a198c0ee074)

5. Select the username created (for example, `Abel Tuter`).

   ![Enter username](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img25.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=a1675e3402d5e0a3c319545cd7af79b9)

6. Navigate to **Workspace Experience > Workspaces > Agent Workspace Home**.

   ![Agent Workspace Home](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img26.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=e82ec91cb8f19c1884d2c271c1453827)

7. In the Agent Workspace, select **Inbox** and set **Status** to **Available**.

   ![Status - Available](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img27.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=c1b2bfe0218a37789d3c85d05e91b0ef)

8. When the user initiates chat, the conversation transfers to the ServiceNow agent and the connection is established.

   ![Connection established](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img28.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=cb035e9a203bee06b36497bc7a286a80)

***

## Additional Capabilities

### Pass User Information to ServiceNow

By default, users appear as Guest in ServiceNow. Use the `ServiceNowMetaData` object with `agentUtils.setMetaInfo` to pass user identity information.

**Steps:**

1. Configure Message Authentication for inbound communication in your ServiceNow instance — see [ServiceNow Message Authentication setup](https://docs.servicenow.com/bundle/vancouver-servicenow-platform/page/administer/virtual-agent/task/set-up-message-auth-va-api.html).
2. Before the agent transfer node, set meta info using a Script node:

   ```javascript theme={null}
   let metaData = {
     "payloadFields": {
       "userId": context.entities.UserID,    // ServiceNow user ID (dynamic or static)
       "emailId": context.entities.UserEmail // ServiceNow user email (dynamic or static)
     },
     "headerFields": {
       "token": "Token_generated_in_ServiceNow_Instance"
     }
   }

   agentUtils.setMetaInfo("ServiceNowMetaData", JSON.stringify(metaData))
   ```

   The app can collect `UserID` and `UserEmail` via entity nodes.

   ![Entity nodes for user info](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img29.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=9098c2e0eeffa39d3e6776724ed7b5f7)

   > [!NOTE]
   >
   > Context doesn't include user ID or email by default. Capture required details explicitly. If `ServiceNowMetaData` isn't defined, values aren't shared with ServiceNow.

### Route Messages to Agent Groups by `streamId`

The platform sends `streamId` as a context variable in the ServiceNow request payload. Use it to route work items to different agent groups via a Work Item Routing Condition.

**Steps:**

1. In **Conversational Interfaces Home**, create a new context variable named `streamId`.

   ![New context variable streamId](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img30.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=ed834c713acaf69d0496e6598d441e5e)

2. Define a Work item routing condition in the Queue using the `streamId` context variable.

   ![Work item routing condition](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img31.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=f9df728bb54417b25616539a5881951d)

3. Configure the routing condition in every queue that handles these work items. If queue 1 has a `streamId` condition but queue 2 doesn't, both queues will qualify. Define the condition in all relevant queues.

Reference:

* [ServiceNow: Create a work item queue](https://docs.servicenow.com/bundle/tokyo-servicenow-platform/page/administer/advanced-work-assignment/task/awa-create-queue.html)

  ![Create a work item queue](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img32.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=2be5fda043fb441e12d9e2d91fe94b40)

* [ServiceNow: Virtual Agent Bot Integration API](https://developer.servicenow.com/dev.do#!/reference/api/tokyo/rest/bot-api)

  ![Virtual Agent Bot Integration API](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/configuring-the-servicenow-agent-utah-and-vancouver-img33.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=c9ed3e0845cc2d11a8538d6e2213ab07)

### Enable Attachment Sharing with Live Agents

1. Log in to ServiceNow with admin credentials.
2. Navigate to **System Properties > sys\_cs\_provider\_application.list > Configure > Form Layout**.
3. In the **Trusted Media Domains** field, enter the domain for sending and receiving attachments.

   ![Attachment Sharing](https://mintcdn.com/koreai/gPfH5zsUPYZ8MZRE/ai-for-service/integrations/agents/servicenow/images/sn-at.png?fit=max\&auto=format\&n=gPfH5zsUPYZ8MZRE\&q=85\&s=edba824b22c791603c81b7e2716d0d0d)

   > [!NOTE]
   >
   > This feature supports only Utah and Vancouver versions.

### Agent Transfer Status

The platform records agent transfer status in Debug Logs and Analytics, enabling tracking and troubleshooting of transfer-related issues.

### Failed Agent Transfer Notification

When a ServiceNow agent transfer fails due to agent unavailability, users see a default non-editable message:

*No agents are available to handle your request. Please try again later.*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.