ServiceNow Integration

This guide walks through configuring OAuth 2.0 (Client Credentials) for your ServiceNow integration with Compyl. There are two paths depending on your identity provider:

  • Native ServiceNow OAuth (most common)
  • Federated authentication via Microsoft Entra ID (Azure AD)

You can only select one path.

Please refer to the Required Permissions doc for all scopes necessary for this integration.


🚧

Prerequisites

The following 4 ServiceNow plugins must be active on the instance. Without them, the OAuth registry options will not appear:

PluginPlugin ID
OAuth 2.0com.snc.platform.security.oauth
REST API Providercom.glide.rest
Authentication Scopecom.glide.auth.scope
REST API Auth Scopecom.glide.rest.auth.scope

Additionally:

  • A ServiceNow instance with admin access
  • An active integration user (service account) in ServiceNow with the roles required for the tables the integration reads

Enable the Client Credentials Grant Type

  1. Go to System Properties → All Properties or type in sys_properties.list in the navigation filter.

  2. Select New and complete the following fields:

  • Name: glide.oauth.inbound.client.credential.grant_type.enabled
  • Type: true | false
  • Value: true
  1. Click Submit.

Configure the OAuth Application

  1. Go to System OAuth → Application Registry and select New.

  2. Select Create an OAuth API endpoint for external clients.

  3. Enter a name for the application (e.g. Compyl Integration).

  4. In the Default Grant Type field, select Client Credentials.

  5. In the OAuth Application User field, select the integration user to associate with this application.

    🚧

    Caution

    This field is required. If left blank, token requests will return a 401 error.

  6. Select Save.

  7. After saving, ServiceNow auto-generates the Client ID and Client Secret.

    ❗

    Important

    Copy both values now to a secure location. The Client Secret may only be fully visible at creation time.

Add Configuration

  1. Navigate to the Integrations tab using the left-hand menu, find Integration Name, and select +Add Configuration.

  2. Next, fill in the details below and select Continue.


    Name: Enter the name of the integration.

    is Enabled: Toggle button to ensure data is populated into Compyl.

    Use Entra ID: Since we are using ServiceNow's native OAuth, leave this untoggled.

    Instance: Your ServiceNow instance name (e.g. yourcompany if your URL is https://yourcompany.service-now.com)

    Client ID: From the OAuth application created above.

    Client Secret: From the OAuth application (stored securely; the secret is never persisted in the database).

  3. Choose your Endpoints and Begin Validation to validate your connection.

  4. Select any Blueprints you wish to associate with this integration.

  5. After you hit Continue, you'll see a summary screen. Click Return to Integrations to complete the configuration.

Once you have completed filling out the form click Return to Integrations.

You'll know the integration is successfully added when the status updates to Complete.


Data is synced on a recurring schedule configured by your Compyl administrator. Each sync pulls the latest data from all enabled endpoints.

To query the data from the integration, refer to the Blueprints article.


Did this page help you?