APIs & Integrations
ServiceNow
Overview
Pre-built tooling
Pre-built integrations
No pre-built integration yet (time to contribute: <48h)
Not seeing the integration you need? Build your own independently.
Access requirements
Pre-Requisites | Status | Comment |
---|---|---|
Paid dev account | ⚠️ Conditional | A ServiceNow Developer Instance is free, but production instances require a paid subscription. |
Paid test account | ✅ Not required | Free developer instance can be used for testing. |
Partnership | ✅ Not required | |
App review | ✅ Not required | |
Security audit | ✅ Not required |
Setup guide
1
Create a ServiceNow Developer Account
- Go to the ServiceNow Developer Portal.
- Click Sign up and Start Building to create a new account if you don’t already have one.
- Complete the registration process.
2
Request a Personal Developer Instance (PDI)
- After logging in to the Developer Portal, navigate to Start Building.
- Click Request Instance.
- Select the latest ServiceNow release version.
- Wait for your instance to be provisioned (this usually takes a few minutes).
- Once provisioned, you’ll receive an email with your instance details, including the URL, admin username, and password.
3
Log in to your ServiceNow instance
- Navigate to your instance URL (typically in the format
https://[your-instance-name].service-now.com/
). - Log in with the admin credentials provided in the email.
4
Create an OAuth API endpoint for external clients
- In your ServiceNow instance, navigate to System OAuth > Application Registry.
- Click New to create a new OAuth application.
- Select Create an OAuth API endpoint for external clients.
- Fill in the following fields:
- Name: Enter a descriptive name for your application.
- Client ID: This will be auto-generated.
- Client Secret: This will be auto-generated.
- Redirect URL: Enter
https://api.nango.dev/oauth/callback
.
- Click Submit to create the application.
5
Configure OAuth scopes
- In the Application Registry, find and open your newly created application.
- In the Application Scope tab, click Add.
- Search for and select the API scopes your application needs. Common scopes include:
- admin: Full administrative access
- user_admin: User administration
- user: Access to user data
- useraccount: Access to user account data
- web_service_admin: Web service administration
- web_service: Access to web services
- personalize: Personalization capabilities
- impersonate: Ability to impersonate users
- Click Save to apply the selected scopes.
6
Configure OAuth policies
- In your application record, navigate to the OAuth Policies tab.
- Configure the following settings:
- Access Token Lifespan: Default is 30 minutes (1800 seconds). You can adjust this as needed.
- Refresh Token Lifespan: Default is 8 hours (28800 seconds). You can adjust this as needed.
- Refresh Token Count: Set to “Unlimited” to allow continuous refreshing of tokens.
- Click Update to save your changes.
7
Obtain your OAuth credentials
- In the Application Registry, open your application.
- Note the Client ID and Client Secret values.
- Also note your instance URL, as you’ll need this for the authorization and token endpoints.
8
Configure your integration in Nango
When setting up your ServiceNow integration in Nango:
- Use your Client ID and Client Secret from the previous step
- For the authorization URL, use:
https://[your-instance-name].service-now.com/oauth_auth.do
- For the token URL, use:
https://[your-instance-name].service-now.com/oauth_token.do
- Replace
[your-instance-name]
with your actual ServiceNow instance name
9
Next
Follow the Quickstart.
Need help getting started? Get help in the community.
Useful links
- ServiceNow Developer Portal
- ServiceNow Documentation
- ServiceNow Community
- OAuth Applications
- Create OAuth API Endpoints
- OAuth Scopes
- REST API Documentation
- API Explorer
- API Best Practices
Contribute useful links by editing this page
Common Scopes
Scope | Description |
---|---|
admin | Full administrative access |
user_admin | User administration capabilities |
user | Access to user data |
web_service | Access to web services |
personalize | Personalization capabilities |
useraccount | Access to user account data |
API gotchas
Contribute API gotchas by editing this page