Configure other integration options

task brazil Updated Oct 27, 2026 3 min read configure-other-integration-options.md
Raw file servicenow.com

Configure the Other integration to create work items in any external system by using a payload script, an endpoint, a username, and an API token.

Before you begin

The API endpoint URL, the username, and the API token for your external system must be available. The request body format that the external system expects must also be known, because the payload script must produce it.

Role required: Scan Engine admin (sn_se.scan_engine_admin). Only users with this role can edit the Payload script.

Configure this integration on the instance where Scan Engine runs and the findings are generated. You don't select a target instance, and no My SN Instances record is required.

Procedure

  1. Navigate to All > Impact > Configuration > Scan Engine Properties and select the User Story Integration properties tab.

  2. Set Integration to Other.

    The Payload field appears only when Integration is set to Other.

  3. Populate the following fields.

    Field Value
    Integration Name A descriptive name for this integration.
    End Point The full URL of the API to call. Select the lock icon next to the field to enter the URL.
    Content Type The content type required by the external API (for example, application/json).
    Issue Type The work item type to create in the external system.
  4. In the Payload field, enter the script that builds the request body.

    See Other integration leading practices for available script variables and leading practices.

  5. Enter the Username and API Token for the external system.

    Select the lock icon next to API Token to enter the token. The username and API token are used in a basic authentication authorization header. See the security note that follows these steps.

What to do next

Important: The API token field is a text field, so the platform doesn't encrypt its value by default. If your organization uses Edge Encryption, you can encrypt this field. Restrict access to Scan Engine Properties to users who need it, and use a token with the narrowest access your external system allows.

Parent Topic:Scan Engine integrations

Other integration leading practices

The following leading practices are guidelines for creating other integration type scripts.

Script variables

The payload script runs on the ServiceNow instance when a work item is created. Use the payload variable to build the request body in the format your external system requires. The script output is sent as the request body to the configured endpoint using basic authentication.

Variable Description
payload The content to send in the request body. Structure this object to match the format expected by your external API.
grFinding GlideRecord of the finding. Use this to read finding data for the request body.
workItemType The work item type selected for this integration.

Leading practices

  • Review your target API documentation before writing the script

    The external system's API determines the required request body format, field names, and data types. Review the API documentation for your target system before building the payload object to avoid silent mapping failures.

  • Match the payload structure to the API's expected format

    Set the Content type field and the structure of payload to match what the API expects. For a JSON API, build payload as a plain JavaScript object — it will be serialized automatically. For other formats, construct the payload string directly.

  • Use grFinding to include finding context

    Read finding fields using standard GlideRecord methods on grFinding and map them to the fields your external system expects. For example, grFinding.getValue('short_description') can populate a title or summary field.

  • Enable ES12 mode for modern JavaScript

    To use modern JavaScript syntax, enable ECMAScript 2021 (ES12) mode in Scan Engine Properties before writing your payload script.

Search documentation
Search document titles and file paths on the brazil branch