Skip to main content

ServiceNow Plugin

The ServiceNow plugin connects Venue.sh components to ServiceNow incident tickets. It maps Backstage entities to ServiceNow records using the servicenow.com/entity-id annotation.

Prerequisites​

Before enabling the plugin, make sure you have:

  • A ServiceNow instance URL (for example: https://my-company.service-now.com)
  • A ServiceNow OAuth client (clientId and clientSecret)
  • A ServiceNow integration user (username and password)
note

This integration uses the OAuth password grant type.

For token endpoints, grant types, and request parameter details, see ServiceNow’s OAuth API request parameters documentation.

Create ServiceNow OAuth Credentials​

In ServiceNow, create an OAuth application for external clients and collect the credentials required by Venue.sh.

  1. Open System OAuth > Application Registry.
  2. Click New.
  3. Select Create an OAuth API endpoint for external clients.
  4. Complete the form and save.
  5. Copy the generated Client ID and Client Secret.
  6. Confirm the integration user account (username/password) that Venue.sh should use.

Configure the ServiceNow Plugin in Venue.sh​

  1. In Venue.sh, click Plugins in the left-side navigation.
  2. Find ServiceNow, then click Enable Plugin.
  3. Complete the plugin form:
    • Instance URL: The base URL of your ServiceNow instance. (Example: https://my-company.service-now.com)
    • OAuth Grant Type: Automatically set to password.
    • Client ID: The OAuth client ID from ServiceNow.
    • Client Secret: The OAuth client secret from ServiceNow.
    • Username: ServiceNow username for the integration account.
    • Password: ServiceNow password for the integration account.
  4. Click Enable.

Component Setup​

Add the following annotation to your component catalog-info.yaml:

metadata:
  annotations:
    servicenow.com/entity-id: [YOUR_ENTITY_ID]
tip

The annotation value must match the u_backstage_entity_id field used in your ServiceNow incident records.

Validation Rules​

Venue.sh validates the plugin configuration as follows:

  • instanceUrl must be a valid URL
  • instanceUrl must match the ServiceNow domain pattern (*.service-now.com)
  • All OAuth fields are required: clientId, clientSecret, username, and password

References​

To learn more, see OAuth API request parameters, the official ServiceNow documentation for OAuth setup, which includes additional info on grant types, endpoints, parameters, and more.