This article describes the one-time configuration to add a ServiceNow provider. The ServiceNow provider can be used with either the dedicated ServiceNow tile, or the Web API tile.
Should you use the Web API tile or the dedicated ServiceNow tile?
The ServiceNow tile offers easier configuration and the ability to use the donut visualisation. You can display incidents and change request with the ServiceNow tile. If you want to use any other data from ServiceNow, you need to use the Web API tile.
The Web API tile can display other data in addition to incidents and change requests, it gives you more flexibility and advanced configurations. Using the Web API tile is described in this article.
The ServiceNow tile needs a specific ServiceNow provider to be configured in SquaredUp, as described in this article (rather than a Web API oauth provider). The ServiceNow specific provider can also be used if you need to use the Web API tile to show ServiceNow data.
- The SquaredUp server must have access to your ServiceNow instance on port 443 (HTTPS), since it is the server that connects to ServiceNow, and not your users' browser.
- If you use a proxy server you may need to configure the proxy to allow the ServiceNow tile to communicate with ServiceNow.
- A ServiceNow instance.
- The username and password of a ServiceNow account to use in the provider configuration for requests to ServiceNow (we recommend a service account).
- This ServiceNow account must have the 'web_service_admin' role and check 'Allow access to this table via web services'. You may need some help from a ServiceNow admin to get an account with the correct privileges.
- To allow the ServiceNow views to be pulled into the ServiceNow Grid tile the ServiceNow account must also have the 'admin' role in ServiceNow.
Configuration in ServiceNow
- In the Application Navigator (left-hand menu) go to System OAuth and click Application Registry.
- Click Create an OAuth API endpoint for external clients.
- Call it something like
SquaredUpto make it easier to remember, all the other defaults should be fine.
- Once you've created the endpoint, open the entry to view the client ID and secret (click the padlock next to the client secret to see it!) and copy these into a notepad for use later.
Adding a ServiceNow provider in SquaredUp
- Log on to SquaredUp and navigate to the right-hand menu ☰ > system > Integrations.
- In Add An Integration click ServiceNow:
- Type in a suitable name, e.g. ServiceNow.
- The instance url should look something like
instancenameis your instance (if
/api/now/is not included as part of the instance URL then it will be automatically appended to this URL when the provider is created). If ServiceNow is installed on-premises, this may be something different. This URL is prepended to every request URL.
- client id and secret are taken from the notes you made earlier.
- username and password of the ServiceNow account which has been setup with the permissions listed in the prerequisites.
- Click Save.
If the configuration is correct it will show a green tick under Active Integrations.
If the provider is not authorized it could be that some of the provider configuration is incorrect (for example the username, password, secret etc), or if you use a proxy it could be that the proxy is not configured. See How to configure SquaredUp to use a proxy.