ServiceNow ITSM connector and actionedit

The ServiceNow ITSM connector uses the import set API to create ServiceNow incidents. You can use the connector for rule actions and cases.

Create connectors in Kibanaedit

You can create connectors in Stack Management > Connectors or as needed when you’re creating a rule. You must choose whether to use OAuth for authentication.

ServiceNow connector using basic auth
ServiceNow connector using OAuth
Connector configurationedit

ServiceNow ITSM connectors have the following configuration properties:

Client ID
The client identifier assigned to your OAuth application.
Client secret
The client secret assigned to your OAuth application.
JWT verifier key ID
The key identifier assigned to the JWT verifier map of your OAuth application.
The password for HTTP basic authentication.
Private key
The RSA private key that you created for use in ServiceNow.
Private key password
The password for the RSA private key. This values is required if you set a password for your private key.
ServiceNow instance URL
The full URL for the ServiceNow instance.
Use OAuth authentication
By default, basic authentication is used instead of open authorization (OAuth).
User identifier
The identifier to use for OAuth type authentication. This identifier should be the user field you selected during setup. For example, if the selected user field is Email, the user identifier should be the user’s email address.
The username for HTTP basic authentication.

Test connectorsedit

When you create or edit a connector, use the Test tab to test its actions:

ServiceNow params test

ServiceNow ITSM actions have the following configuration properties.

Additional comments
Additional information for the client, such as how to troubleshoot the issue.
The category of the incident.
Correlation display
A descriptive label of the alert for correlation purposes in ServiceNow.
Correlation ID

Connectors using the same correlation ID will be associated with the same ServiceNow incident. This value determines whether a new ServiceNow incident will be created or an existing one is updated. Modifying this value is optional; if not modified, the rule ID and alert ID are combined as {{ruleID}}:{{alert ID}} to form the correlation ID value in ServiceNow. The maximum character length for this value is 100 characters.

Using the default configuration of {{ruleID}}:{{alert ID}} ensures that ServiceNow will create a separate incident record for every generated alert that uses a unique alert ID. If the rule generates multiple alerts that use the same alert IDs, ServiceNow creates and continually updates a single incident record for the alert.

The details about the incident.
The effect an incident has on business. It can be measured by the number of affected users or by how critical it is to the business in question.
The severity of the incident.
Short description
A short description for the incident, used for searching the contents of the knowledge base.
The category of the incident.
The extent to which the incident resolution can delay.

When you create a rule that uses a ServiceNow ITSM connector, its recovery actions close ServiceNow incidents based on the correlation ID. If there are multiple incidents that match the correlation ID, the latest open incident for that ID is closed.

Connector networking configurationedit

Use the Action configuration settings to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.

Configure ServiceNowedit

ServiceNow offers free Personal Developer Instances, which you can use to test incidents.


After upgrading from Elastic Stack version 7.15.0 or earlier to version 7.16.0 or later, you must complete the following steps within your ServiceNow instance before creating a new ServiceNow ITSM connector or updating an existing one:

Assign cross-scope privilegesedit

The Elastic for ITSM app requires specific cross-scope privilege records to run successfully. In particular, you must have a privilege record for the Elastic for ITSM application with the status set to Allowed for each of the following targets:

Target scope Name Type Operation




Execute API




Execute API




Execute API








Execute API




Execute API

To access the cross scope privileges table:

  1. Log into ServiceNow and set your application scope to Elastic for ITSM.
  2. Click All and search for sys_scope_privilege.

For more details, refer to the ServiceNow product documentation.

Create a ServiceNow integration useredit

To ensure authenticated communication between Elastic and ServiceNow, create a ServiceNow integration user and assign it the appropriate roles.

  1. In your ServiceNow instance, go to System Security → Users and Groups → Users.
  2. Click New.
  3. Complete the form, then right-click on the menu bar and click Save.
  4. Go to the Roles tab and click Edit.
  5. Assign the integration user the following roles: 

    • import_set_loader
    • import_transformer
    • personalize_choices
    • x_elas2_inc_int.integration_user
  6. Click Save.
Create a CORS ruleedit

A CORS rule is required for communication between Elastic and ServiceNow. To create a CORS rule:

  1. In your ServiceNow instance, go to System Web Services → REST → CORS Rules.
  2. Click New.
  3. Configure the rule as follows:

    • Name: Name the rule.
    • REST API: Set the rule to use the Elastic ITSM API by choosing Elastic ITSM API [x_elas2_inc_int/elastic_api].
    • Domain: Enter the Kibana URL, including the port number.
  4. Go to the HTTP methods tab and select GET.
  5. Click Submit to create the rule.
Create an RSA keypair and add an X.509 certificateedit

This step is required to use OAuth for authentication between Elastic and ServiceNow.

Create an RSA keypair:

  1. Use OpenSSL to generate an RSA private key:

    openssl genrsa -out example-private-key.pem 3072
    openssl genrsa -passout pass:foobar -out example-private-key-with-password.pem 3072 

    Use the passout option to set a password on your private key. This is optional but remember your password if you set one.

  2. Use OpenSSL to generate the matching public key:

    openssl req -new -x509 -key example-private-key.pem -out example-sn-cert.pem -days 360

    Add an X.509 certificate to ServiceNow:

  3. In your ServiceNow instance, go to Certificates and select New.
  4. Configure the certificate as follows:

    • Name: Name the certificate.
    • PEM Certificate: Copy the generated public key into this text field.
    Shows new certificate form in ServiceNow
  5. Click Submit to create the certificate.
Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Mapedit

This step is required to use OAuth for authentication between Elastic and ServiceNow.

  1. In your ServiceNow instance, go to Application Registry and select New.
  2. Select Create an OAuth JWT API endpoint for external clients from the list of options.

    Shows application type selection
  3. Configure the application as follows:

    • Name: Name the application.
    • User field: Select the field to use as the user identifier.
    Shows new application form in ServiceNow

    Remember the selected user field. You will use this as the User Identifier Value when creating the connector. For example, if you selected Email for User field, you will use the user’s email for the User Identifier Value.

  4. Click Submit to create the application. You will be redirected to the list of applications.
  5. Select the application you just created.
  6. Find the Jwt Verifier Maps tab and click New.
  7. Configure the new record as follows:

    • Name: Name the JWT Verifier Map.
    • Sys certificate: Click the search icon and select the name of the certificate created in the previous step.
    Shows new JWT Verifier Map form in ServiceNow
  8. Click Submit to create the verifier map.
  9. Note the Client ID, Client Secret and JWT Key ID. You will need these values to create your ServiceNow connector.

    Shows where to find OAuth values in ServiceNow

Update a deprecated ServiceNow ITSM connectoredit

ServiceNow ITSM connectors created in Elastic Stack version 7.15.0 or earlier are marked as deprecated after you upgrade to version 7.16.0 or later. Deprecated connectors have a yellow icon after their name and display a warning message when selected.

Shows deprecated ServiceNow connectors

Deprecated connectors will continue to function with the rules they were added to and can be assigned to new rules. However, it is strongly recommended to update deprecated connectors or create new ones to ensure you have access to connector enhancements, such as updating incidents.

To update a deprecated connector:

  1. Open the main menu and go to Stack Management > Connectors.
  2. Select the deprecated connector to open the Edit connector flyout.
  3. In the warning message, click Update this connector.
  4. Complete the guided steps in the Edit connector flyout.

    1. Install Elastic for ITSM and complete the required prerequisites.
    2. Enter the URL of your ServiceNow instance.
    3. Enter the username and password of your ServiceNow instance.
  5. Click Update.