ServiceNow Integration
The ServiceNow integration enables SEI 2.0 to ingest incident and change management (ITSM) data from ServiceNow. This data can be used to track operational performance and correlate incidents and changes with engineering metrics in SEI dashboards.
SEI 2.0 supports the following authentication methods:
- API key authentication using a ServiceNow API key with permissions to read ServiceNow data
- Username/password authentication using ServiceNow account credentials
- OAuth authentication using a ServiceNow client ID and client secret
Prerequisites
Before you can configure the ServiceNow integration, ensure you have the following requirements:
- A ServiceNow instance URL
- Admin access to your ServiceNow account
- A ServiceNow service account with the required permissions
Ensure the ServiceNow service account has the following roles:
| Role | Description |
|---|---|
itil | Provides access to IT Service Management (ITSM) data such as incidents, change requests, users, and CMDB records. |
personalize_choices | Allows SEI to retrieve choice field labels such as incident state and severity values. |
personalize_dictionary | Allows SEI to retrieve field metadata and custom field definitions. |
oauth_admin | Required only when configuring OAuth applications in ServiceNow. |
user | Required to ingest user-related metadata for all users in the ServiceNow instance. Assign together with user_admin. |
user_admin | Optional. Required only if you want to ingest extended user attributes. |
To ingest user-related metadata for all users in the ServiceNow instance, ensure that user and user_admin roles are also assigned.
If your ServiceNow instance uses IP allowlisting, ensure the required Harness IP addresses are added to the allowlist.
Go to Harness Platform IPs to add the required Harness IP addresses to your allowlist.
Configure OAuth in ServiceNow
To use OAuth authentication, create an OAuth application in ServiceNow.
-
Log in to ServiceNow with an administrator account.
-
Navigate to System OAuth > Application Registry.
-
Click New.
-
Select Create an OAuth API endpoint for external clients.
-
Enter a name for the application.
-
Add the redirect URL generated during the ServiceNow integration setup.
-
In the Auth Scopes section, add the
table_readscope. -
Save the application.
-
Copy the generated Client ID and Client Secret for use during integration setup.
dangerThe Client ID and Client Secret are sensitive credentials. Store them securely.
Setup
To configure the ServiceNow integration:
-
From the SEI navigation menu, click Account Management.
-
From the Integrations page, navigate to the Available Integrations tab.
-
Locate the ServiceNow integration tile under
Incident Managementand click Add Integration. -
Select an installation option: ServiceNow Cloud or ServiceNow On-Prem.
- ServiceNow Cloud
- ServiceNow On-Prem
Once you've selected ServiceNow Cloud, click Using Cloud Credentials (prerequisites include ServiceNow account with Admin access and a ServiceNow account with username and password) or Using OAuth (prerequisites include ServiceNow account with Admin access, ServiceNow client ID, and ServiceNow client secret).
If you are using Cloud Credentials:
-
In the Overview section, enter a name for the integration. Optionally, add a description or tags.
-
In the Credentials section, enter your ServiceNow URL and select an authentication method: API Key or Username.
- For API Key, enter your API token in the
API Tokenfield. - For Username, enter a username and password in the
UsernameandPasswordfields.
- For API Key, enter your API token in the
-
Enter a timezone in the
Timezonefield. -
Optionally, to limit the incidents and change requests ingested into SEI 2.0, create a filter query in ServiceNow.
-
In ServiceNow, create and copy the query string for the incidents or change requests you want to ingest, then paste the query into the appropriate filter fields in the Advanced Configuration section.
-
Click Validate Connection.
-
Once validation succeeds, click Validate and Create Integration.
If you are using OAuth:
- In the Overview section, enter a name for the integration. Optionally, add a description or tags.
- In the Credentials section, enter your ServiceNow URL and copy the generated redirect URL.
- In ServiceNow, configure your Application Registry to include the redirect URL.
- Enter a client ID and client secret.
- Enter a timezone in the
Timezonefield. - Optionally, to limit the incidents and change requests ingested into SEI 2.0, create a filter query in ServiceNow.
- In ServiceNow, create and copy the query string for the incidents or change requests you want to ingest, then paste the query into the appropriate filter fields in the Advanced Configuration section.
- Click Connect ServiceNow.
- Once validation succeeds, click Validate and Create Integration.
Once you've selected ServiceNow On-Prem:
- In the Overview section, enter a name for the integration. Optionally, add a description or tags.
- In the Provide ServiceNow Details section, enter your ServiceNow URL and provide a username and password.
- Enter a timezone in the
Timezonefield. - Optionally, to limit the incidents and change requests ingested into SEI 2.0, create a filter query in ServiceNow.
- In ServiceNow, create and copy the query string for the incidents or change requests you want to ingest, and add it to the appropriate fields in the Advanced Configuration section.
- Click Download YAML File. This
satellite.ymlfile contains the metadata and configurations for establishing the connection and data ingestion from ServiceNow. - Deploy the
satellite.ymlfile to your on-premises infrastructure. - Click Done.
Once the integration is configured, Harness SEI begins ingesting ITSM data from ServiceNow.
Custom fields
The Custom Fields tab allows you to map additional ServiceNow fields to SEI. You can use custom fields to include organization-specific metadata (such as priority, assignment group, or custom attributes) in your SEI dashboards and reports.
You can map custom fields by defining filter sets for incident and change request identification on the Incident Management tab in Team Settings.

Once configured, these fields are included in data ingestion and become available for filtering and analysis in SEI 2.0.
Integration monitoring
To monitor the status of the ServiceNow integration, navigate to the Monitoring tab. This page displays ingestion logs that provide visibility into data synchronization.
You can click the Filters icon to filter logs by Status (Success, Failed, Pending, or Scheduled).
Each ingestion log includes the following fields:
| Field | Description |
|---|---|
| Scan Range Time | The time window of data retrieved from ServiceNow during the ingestion task. |
| Data Retrieval Process | The ingestion job responsible for fetching data from ServiceNow. |
| Task Start Time | The timestamp when the ingestion task began running. |
| Status | The current state of the ingestion task (for example, Success, Failed, Pending, or Scheduled). |
| Time to Complete | The total duration required for the ingestion task to complete. |
| Retries | The number of times the ingestion task was retried after a failure. |