ServiceNow Worker


ServiceNow (SNOW) has enabled API access to bots built within SNOW. We are using the Virtual Agent API whereby the SNOW Virtual Agent acts as a “Secondary bot”.

ServisBOT is integrating into SNOW so that ServisBOT customers can:

  • Access existing workflows in ServiceNow via ServisBOT experiences like L2 messenger.
  • Add ServiceNow capabilities into larger Virtual Assistant experiences.


  • ServiceNow will operate as a Remote BYOB bot. No programming / altering of the ServiceNow bot will occur via ServisBOT automation.

Creating a ServiceNow Worker through CLI

Save this json to a file and create a worker using the cli command sb-cli worker create file.json

    "Data": {
        "Url": "",
        "ServiceNowBasicAuthCredentials": "srn:vault::my-org:secretdoc:basicauthcreds",
        "VaProviderMessageAuth": "srn:vault::my-org:secret:servicenowkey",
        "NluConfidenceThresholdOverride": 0.9,
        "ResponseApiKey": "API_KEY_FROM_BASIC_AUTH_PROFILE"
    "Organization": "my-org",
    "Config": {},
    "Enabled": true,
    "Updated": 1620644024351,
    "Description": "work work",
    "Id": "b9df9533-2e4e-4512-8fea-659ab92fd35f",
    "Type": "servicenow-worker",
    "Name": "servicenowtest",
    "Created": 1620644024351,
    "Status": "published",
    "Srn": "srn:botnet:region:my-org:worker:b9df9533-2e4e-4512-8fea-659ab92fd35f"  
  • Url: The URL of the service now integration
  • ServiceNowBasicAuthCredentials: A secret document, of format { "username" : "username", "password" : "password" }
  • VaProviderMessageAuth: A secret containing the token value required for the VA provider
  • NluConfidenceThresholdOverride: The confidence threshold that must to stop the working passing onwards
  • ResponseApiKey: The value ServiceNow sends as an API Key to talk to ServisBOT. The password portion of a basic auth profile configured as part of the REST Message HTTP Method.

Getting Started Guide

  1. Setup a worker in ServisBOT
    • Use CLI to set up the worker (shown above)
  2. Configure ServiceNow to work with ServisBOT
    • Ensure account is setup properly
    • Webhook must be pointing at ServisBOT
  3. Test
  4. Look at metrics

SNOW Account Setup

Signing Up

  1. Visit and sign up for an account
  2. Activate your account with the email sent to you
  3. Return to and sign in with the account just created
  4. After logging into your account for the first time you will be prompted with ‘Do you code?’

  1. For this setup we are going to use the ‘developer oriented IDE’’. Select ‘Yes’

After the initial setup a popup will appear after a short period of time with your created instance. Keep track of these credentials

Installing Required Plugins

  1. Open your profile on

  1. Select Activate Plugin

  2. Use the search box to search for ‘agent’

  3. Activate the required plugins (This may take some time)

    • ‘Glide Virtual Agent’
    • ‘Customer Service Virtual Agent Conversations’

Visiting Your Instance

Go to your instance using the ‘Start Building’ button located in your profile at:

Creating a Simple Topic

  1. Enter the virtual agent designer (Collaboration -> Virtual Agent -> Designer)

  1. Click ‘Create’

  1. Add a name
  2. Select the type of ‘Topic’
  3. Add a keyword if none exists, remember this keyword for later
  4. Click ‘Create’

After creation you will be brought to the flow designer

  1. Add a ‘Text’ Bot Response block between the start and end and configure the response message & name fields.

  1. Save, Toggle the flow to ‘Active’, Publish

Adding the VA to ServiceNOW

  1. Navigate to https://<YOUR_INSTANCE_ID>
  2. CTRL + Right Click on an element in the portal of your instance

  1. Click ‘Page in Designer’
  2. Search for ‘virtual’ and drag and drop the ‘Virtual Agent Service Portal Widget’ into the footer of the page

The Virtual Agent will be added in the button right corner on your instance (https://<, test out the topic you made now by typing your keyword!

Install the Virtual Agent API

  1. Return to https://<YOUR_INSTANCE_ID>
  2. Navigate to System Applications -> All Available Applications -> All

  1. Search for ‘Virtual Agent API’
  2. Install the Virtual Agent API

Connect to ServisBOT

Your ServisBOT representative will provide you with your username password combination & the endpoint required for you to communicate with.

SerivsBOT -> ServiceNOW Webhook URL:


For these URLs, substitute ORGANIZATION for your organization name.
Note ServiceNow is not an endpoint name, but part of the API route. This API does not need to know the endpoint of your bot.

ServisBOT Instructions:

We’re going setup ServiceNOW to send it’s responses to user input back to ServisBOT, for presentation. As part of this step, we’ll create a webhook connection ServiceNOW -> ServisBOT, and authenticate this using a static API key (in this case, the password field of a Basic Authentication provider).

  1. Retrieve and provide the SerivsBOT -> ServiceNOW Webhook URL for the region your organization is in (see above)
  2. Navigate to System Web Services -> Outbound -> REST Message
  3. Open ‘VA Bot to Bot’
  4. Change the URL you have been provided with to:
    • The endpoint on the base resource
    • The endpoint postMessage HTTP Method

  1. Add Authentication
    • Select Authentication Type ‘Basic’
    • Use the lookup function on basic auth profile to allow you to create a new profile
    • This

  • Create a new profile with a username and password.
  • Update to add the newly created profile as the ‘Basic Auth Profile’ on the previous HTTP method screen.
  • In ServisBOT, set Data.ResponseApiKey on the worker to the plain text value of this basic auth profile. (Just the password - and not as a secret)

Setup a ServiceNow Worker

  1. Create a new secret document in ServisBOT
    • Remember the name of the secret
    • Set the value of the secret to be { "username" : "username", "password" : "password" }

  1. Create a ServiceNow worker using the ServiceNow blueprint
    • Select the secret created in the step above
    • Add the URL as: https://<YOUR_INSTANCE_ID>

Enable Image output of HTML elements on the VA Bot to Bot API:

Many of the flows output HTML as part of their responses to users. Because ServiceNow integrates with services like MS Teams and Slack where HTML support is not available, they have a configuration option to enable image output of HTML elements, which can be set on the VA Bot to Bot provider.

  1. In the filter view, type sys_cs_provider.list and push enter

  1. Select the VA Bot to Bot Provider in the list, and open this record.
  2. Switch application scope to enable editing by clicking the “here” link in the header warning

  1. Modify the view mode of this record by clicking the Hamburger menu -> View -> Select “Provider”

  1. Tick the “HTML to Image Conversation Required” check box
  2. You will be forced to pick a Version. Select “1.0.0”
  3. Click “Update”.
  4. Images will now be output as well as HTML in Bot to Bot API responses. You can verify by observing the presence of an “imageUri” when receiving HTML content from a flow.

Setup Account Linking

  1. Navigate to using the filter navigator (paste and press enter)
  2. Create a new token verification. The value of this token is of your choosing.
  3. Create a plaintext secret in the system, matching the value of this token.
  4. This token will be set in the worker as Data.VaProviderMessageAuth to the secret SRN

  1. Navigate to using the filter navigator (paste and press enter)
  2. Create a new message auth

  1. Navigate to sys_cs_provider.list using the filter navigator (paste and press enter)
  2. Open the ‘VA Bot to Bot Provider’ record
  3. Open the ‘VA Bot to Bot Provider Application’ in the Provider Channel Identity section
  4. Edit the record to add the Message Auth you created

Enable Live Agent handoff

Relevant ServiceNow Documentation Page

  1. The logged in user needs to be added to a Chat Queue Assignment Group. Navigate to the Chat Queue configration page.
  2. Select every Assignment Group link in the list.

  1. For each Assignment Group, Select Group Members tab and click Edit... button.
  2. Add System Administrator to each assignment group.
  3. Log into the Live Agent portal, where you will be assigned conversations.
    • Set Status to available
  4. Trigger a live chat using the bot from the support page: (Select “Live Agent”, or type “agent”)


System Logging:

System logging produces a wide array of informational messages relating to the behavior of the VA Bot to Bot API plugin. These messages are available at:

The list should be sorted by Created

Interaction Logs

When comparing the performance of the ServisBOT integration with that of the Service Page bot widget, the Interaction Logs for one conversation versus another can be a useful resource. These are available here:

The listing is not particularly useful unless sorted by Created - which may be a hidden field heading in the default view. Add by clicking the Cog leftmost of the table headings. Then, sort by date.

Each conversation with a bot (ServisBOT or from the ServiceNOW Widget) will generate an Interaction. This record can be opened by clicking on it’s interaction number. These increase sequentially.

To validate User Linking is working as expected, verify the Interaction Record was Opened For the provided User ID, and not Guest.