ServiceNow API Integrations
Build and run workflows using the ServiceNow API. Use 1000s of source-available triggers and actions across 2,000+ apps. Or write custom code to integrate any app or API in seconds.
Overview#
The ServiceNow API lets developers access and manipulate records, manage workflows, and integrate with other services on its IT service management platform. These capabilities support automating tasks, syncing data across platforms, and boosting operational efficiencies.
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
servicenow: {
type: "app",
app: "servicenow",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://${this.servicenow.$auth.instance_name}.service-now.com/api/now/table/incident`,
headers: {
Authorization: `Bearer ${this.servicenow.$auth.oauth_access_token}`,
},
})
},
})
Choose an API to Connect with ServiceNow API#
1-24of2,000+apps by most popular
Example Use Cases#
- Incident Management Automation: Automatically create incidents in ServiceNow from alerts in Datadog or New Relic.
- HR Onboarding Workflow: Trigger a Pipedream workflow to set up new employee accounts in ServiceNow from HR systems like Workday.
- Customer Support Ticket Sync: Keep customer support tickets synced between ServiceNow and CRM platforms like Salesforce.
Getting Started#
Before using the ServiceNow REST API from a workflow, configure two OAuth apps in your ServiceNow instance. These apps will grant access tokens to your users and authenticate requests to its REST API.
Create an External Client OAuth App
First, sign into your ServiceNow Developer Portal account to create or access an instance.
Go to System OAuth > Application Registry.
Create a new app by selecting New in the top right corner.
Choose Create an OAuth API endpoint for external clients:
Name your app, such as
Pipedream. Use the default settings but specify the Redirect URL:https://api.pipedream.com/connect/oauth/oa_g2oiqA/callback.Click Create. It will appear in the Application Registry once created.
Create the OAuth Validator app
Copy the client ID and secret from the
Pipedreamapp you created above.Name this app
Pipedream OAuth Validatorand add the previously copied client ID and secret.Set the grant type to Authorization Code and the Token URL to
oauth_token.do.Use the same Redirect URL as before.
Visit Pipedream's account page, and click Click Here to Connect An App. Search for ServiceNow and select it. Enter the client ID, client secret, and your instance name (e.g.,
dev98042fromhttps://dev98042.service-now.com/).Press Connect. A new window will prompt you to login to your ServiceNow instance, authorizing Pipedream's access to the ServiceNow REST API.
ServiceNow Authorization Reference
This ServiceNow doc outlines the flow you should implement.
Additional Guidance For Hardened or Mature Instances
The standard instructions may not apply perfectly to customized or hardened ServiceNow instances. If you face a 504 Gateway Time-out error or similar, consider these tips:
- Assign a dedicated role and service account for this integration.
- Ensure the role has ACLs configured for the
oauth_credentialtable and other necessary tables.
Popular ServiceNow Integrations#
Popular ServiceNow Actions#
Troubleshooting#
If you encounter a 504 Gateway Time-out error, refer to the 'Additional Guidance For Hardened or Mature Instances' section for solutions.
Authentication#
ServiceNow uses OAuth authentication. When you connect your ServiceNow account, Pipedream will open a popup window where you can sign into ServiceNow and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any ServiceNow API.
Pipedream requests the following authorization scopes when you connect your account:
- authorization
GEThttps://{{custom_fields.instance_name}}.service-now.com/oauth_auth.do?client_id={{custom_fields.client_id}}&redirect_uri={{oauth.redirect_uri}}&state={{oauth.state}}&response_type=code - accessToken
POSThttps://{{custom_fields.instance_name}}.service-now.com/oauth_token.docontent-type:application/x-www-form-urlencodedaccept:application/jsonclient_id={{custom_fields.client_id}}&client_secret={{custom_fields.client_secret}}&redirect_uri={{oauth.redirect_uri}}&grant_type=authorization_code&code={{oauth.code}} - refreshToken
POSThttps://{{custom_fields.instance_name}}.service-now.com/oauth_token.docontent-type:application/x-www-form-urlencodedaccept:application/jsonclient_id={{custom_fields.client_id}}&client_secret={{custom_fields.client_secret}}&grant_type=refresh_token&refresh_token={{oauth.refresh_token}}