Skip to content

ServiceNow

Connecting ServiceNow to NeuBird enables you to gather critical telemetry from your ServiceNow environment, including incident management and service requests. You will need an API access key and a customer ID.

Before connecting ServiceNow to NeuBird, you need to generate an API key from your ServiceNow instance.

  1. Navigate to the API Access Policies: In your ServiceNow dashboard, go to All > System Web Services > API Access Policies > Inbound Authentication Profile.

    ServiceNow Inbound authentication profile navigation

  2. Create a new API Key: Click New, and then select Create API Key authentication profiles.

    ServiceNow click new button

    ServiceNow create API key authentication profile

  3. Enter API details:

    • Enter a descriptive name for the key in the Name field.
    • In the Auth Parameter field, select Auth Header.

    ServiceNow API details form

    After completing the above steps, click Submit to save your API key profile.

  4. Generate the REST API Key: Go to All > System Web Services > API Access Policies > REST API Key, and click New.

    ServiceNow REST API key navigation

    ServiceNow REST API key click new

  5. Enter REST API details: Provide a descriptive name and select a user or service account for the API key.

    ServiceNow REST API details form

    After completing the above steps, click Submit to save your REST API key.

  6. Navigate to REST API Access Policies: Go to All > System Web Services > API Access Policies > REST API Access Policies.

    ServiceNow REST API Access Policies navigation

  7. Create a new policy: Click New to create a new API Access Policy.

    ServiceNow create new policy

  8. Enter policy details:

    • Name: Enter a descriptive name for your policy.
    • REST API: Select the REST API you want to use. Currently only the Table API is supported.
    • Configure policy restrictions: Use the checkboxes on the right side of the form to uncheck restrictions, allowing fields on the left side to appear.
    • Add API Authentication Profile: Scroll to the embedded list on the form and add your newly created API Authentication Profile.

    ServiceNow policy details form

    Click Submit to save the new API Access Policy. Once saved, a token will be generated. Use the lock icon to view and copy this token.

FieldRequiredDescription
NameYesA descriptive name for this connection
DescriptionNoAn overview of what this connection is used for
API KeyYesThe REST API token generated in the steps above
Customer IDYesYour ServiceNow instance identifier (e.g., https://yourinstance.service-now.com)

For general instructions on creating and managing connections, see the Connections Overview.