Skip to main content

ServiceNow

Setup ServiceNow Developer Instance

Create Instance

Follow steps here

Acquire Relevant Instance Credentials

  1. Login into the developer site
  2. Click on the drop down arrow near your profile in top right corner and select "Manage Instance Password" drawing
  3. Save values for:
    • Instance URL
    • Username
    • Password
  4. Exit. Within "My Instance" view, select "Start Building"
  5. Select "All" in the top navigation panel and search"System OAuth" and select "Applicaiton Registry"
  6. In the top right select "New" and select "Create an OAuth API endpoint for external clients"
  7. Enter necessary details and save the Client ID and Client Secret for later use

Assistant Integration

There are two ways in which the ServiceNow application can be integrated to the Assistant:

watsonx Orchestrate Skill

  1. Within the watsonx orchestrate platform, navigate to the sidebar and select "Chat"
  2. In the dropdown menu in the top select the right target Assistant environment
  3. Select "Add skills from the catalog" and select "ServiceNow"
  4. In the top right select "Connect App"
  5. Enter values Acquire Relevant Instance Credentials:
    • Enpoint URL -> Step 3
    • Username -> Step 3
    • Password -> Step 3
    • Client ID -> Step 7
    • Client Secret -> Step 7
  6. Select "Connect App"
  7. Navigate to the platforms sidebar and select "AI Assistant Builder"
  8. Within the "Actions" section of the buider, select "New Action+" -> "Action from skills" -> appropriate ServiceNow skill

Assistant Custom Extension

Get Developer Instance Credentials and OpenAPI spec

  1. Login into the developer site
  2. Click on the drop down arrow near your profile in top right corner and select "Manage Instance Password" drawing
  3. Make note of the "username" and "password" values (this will be used later)
  4. Exit out of the window and select "Start Building"
  5. Press "All" in the header and search "REST API Explorer"
  6. Press "Export OpenAPI Specification (YAML/JSON)"

Edit Service Now OpenAPI spec

  1. Open the downloaded API spec
  2. Remove the forward slash at the end of the url string within the "servers" block to look like this: drawing
  3. Add BasicAuth Component to the OpenAPI spec (make sure each block is comma delimited):
    "components":{
    "securitySchemes": {
    "basicAuth": {
    "type": "http",
    "scheme": "basic"
    }
    }
    }
  4. Save file

Build Custom Extenstion

  1. Within watsonX Assistant, navigate to the sidebar and select "Integrations"
  2. Select "Build Custom Extension"
  3. For the "Basic Information" page fill out all appropriate fields and click "Next"
  4. Upload the Service Now OpenAPI spec, click "Next" and then "Finish"
  5. Within the extensions in Watson Assistant click "Add+" on the recently made Service Now custom extension
  6. On the Authentication page fill out the username and password fields with the values saved from "Get Developer Instance Credentials and OpenAPI spec" step 3
  7. Click "Next" and then "Finish"