Skip to content

Connecting to ServiceNow#

First Steps with ServiceNow#

Set up an account with ServiceNow.

Cost

Get a custom quote from ServiceNow.

Rate Limits

To prevent excessive inbound REST API requests, set rules that limit the number of inbound REST API requests processed per hour. You can create rules to limit requests for specific users, users with specific roles, or all users. You can learn more about that in the ServiceNow docs.

How to Connect DataDistillr to ServiceNow#

To set up a data source connection for ServiceNow, you will need to have:

  • A unique name for your data source connection to be used in queries
  • The Instance Name associated ServiceNow Instance
  • The Username associated with your ServiceNow Instance
  • The Password associated with your ServiceNow Instance

Data Source Form#

To locate the ServiceNow form, follow the steps in Connecting Your Data to DataDistillr. When you get to the window to choose the data source type, select API as shown below.

Data Source Wizard

On the API screen, select ServiceNow from the list of API forms.

List of APIs

The following form will appear. Instructions are below on how to find the information required to fill each field on the ServiceNow API form.

Once you have filled out all the fields, press the green 'Save' button, and your API will be connected!

ServiceNow Form

Name#

Enter any name that will help you recognize this data source from within your query window.

Acceptable Characters Include

  • lowercase alphanumeric characters
  • underscores

Instance ID, Username, and Password#

Head over to your ServiceNow developer portal. In the top right corner click the profile avatar.

ServiceNow Home Page

Click the "Manage instance password" tab.

Find Instance creds

Here you will find your credentials necessary (Instance name, Username and Password) to connect your ServiceNow instance to DataDistillr.

Instance creds

Endpoints#

The table below shows a list of endpoints available to connect within the DataDistillr application. If you need to connect to an endpoint not listed below, please use the Custom API Form.

Endpoint URL Params Description
tables tableName Returns the table with the matching tableName.
case Returns Customer Service Management (CSM) cases.
user Returns set of (CSM) accounts.
consumer Returns set of (CSM) consumer records.
contact Returns set of (CSM) consumer contacts.

The endpoints above will display as follows in the nav tree once your API has successfully connected.

ServiceNow Endpoints

Sample Queries#

The following queries are intended to help you get started, and make life simpler querying within your API.

For the following examples, suppose that my ServiceNow API data source was called myservicenowapi and I want to query an endpoint. The endpoint goes after the JIRA data source name:

FROM Clause

FROM `myservicenowapi`.`<ENDPOINT>`

Get Tables#

Retrieves multiple records for the specified table.

Get Tables endpoint
SELECT *
FROM `myServiceNowapi`.`tables`
WHERE `tableName`='sn_customerservice_case'
LIMIT 100

Get Case#

Retrieves a specified set of Customer Service Management (CSM) cases.

Get Case endpoint
SELECT *
FROM `myServiceNowapi`.`case`
LIMIT 100

Get User#

Retrieves a specified set of Customer Service Management (CSM) accounts

Get User endpoint
SELECT *
FROM `myServiceNowapi`.`user`
LIMIT 100

Get Consumer#

Retrieves a specified set of Customer Service Management (CSM) accounts

Get Consumer endpoint
SELECT *
FROM `myServiceNowapi`.`consumer`
LIMIT 100

Get Contact#

Retrieves a specified set of Customer Service Management (CSM) contacts.

Get Contact endpoint
SELECT *
FROM `myServiceNowapi`.`contact`
LIMIT 100