Get a ServiceNow incident | New Relic Documentation

Gets an existing incident from ServiceNow using the Table API.

For authentication setup, see ServiceNow Incident actions.

Input	Type	Description	Example
domain	String	Required. Domain of the ServiceNow instance. Used to construct the base URL `your-domain.service-now.com`.	`"your-domain"`
apiKey	String	Required. ServiceNow REST API Key for authentication. Passed as the `x-sn-apikey` request header. Must be provided as a secret.	`"${{ :secrets:serviceNowApiKey }}"`
sysId	String	Required. Unique system ID of the incident to retrieve. Must be a 32-character alphanumeric string (not UUID format).	`"fa7616894723b210f89ff3ac416d43c2"`
parameters	Map	Optional. Optional URL query parameters for the ServiceNow API request. Controls the format and content of the API response. See the parameters reference table below.	`"{\"sysparm_fields\": \"name,short_description\", \"sysparm_exclude_reference_link\": \"true\", \"sysparm_input_display_value\": \"false\", \"sysparm_display_value\": \"true\"}"` See Export to OpenAPI specification for a list of accepted parameters.
selectors	List	Optional.	`[{\"name\": \"incidentNumber\", \"expression\": \".responseBody.result.number\"}]`

Common URL Parameters reference

Parameter	Type	Description	Default
sysparm_fields	String	Comma-separated list of fields to return in the response.
sysparm_exclude_reference_link	String	`true` or `false` to exclude reference links from the response.	`false`
sysparm_display_value	String	`true`, `false`, or `all` to return display values instead of actual values.	`false`
sysparm_input_display_value	String	`true` or `false`. When `true`, sets field values using their display value instead of the actual value.	`false`
sysparm_suppress_auto_sys_field	String	`true` or `false`. When `true`, suppresses auto-generation of system fields.	`false`
sysparm_view	String	Renders the response according to a specific UI view. Overridden by `sysparm_fields`.	`default`
sysparm_query_no_domain	String	`true` or `false`. When `true`, allows access to data across domains if authorized.	`false`

Output	Type	Example
response	Object	`{ "result": { "number": "INC0019382", "description": "The server is on fire.", "short_description": "The server is on fire.", "priority": "3" } }`
success	Boolean	`success: true \| false`
errorMessage	String	`[ { "success": false, "errorMessage": "{\"error\":{\"message\":\"User Not Authenticated\",\"detail\":\"Required to provide Auth information\"},\"status\":\"failure\"}" } ]`

Output

Type

Example

response

Object

{
"result": {
    "number": "INC0019382",
    "description": "The server is on fire.",
    "short_description": "The server is on fire.",
    "priority": "3"
}
}

success

Boolean

success: true | false

errorMessage

String

[
  {
    "success": false,
    "errorMessage": "{\"error\":{\"message\":\"User Not Authenticated\",\"detail\":\"Required to provide Auth information\"},\"status\":\"failure\"}"
  }
]

Workflow example
`name: get-servicenow-incident description: to get a incident from ServiceNow steps: - type: action name: getIncident action: serviceNow.incident.get version: 1 inputs: domain: "your-domain" apiKey: "${{ :secrets:serviceNowApiKey }}" sysId: "ed59ab193b67ba10e811026aa5e45a2d" parameters: sysparm_fields: "number,short_description,description,priority" selectors: - name: sysId expression: .responseBody.result.sys_id next: end`

Workflow example

name: get-servicenow-incident
description: to get a incident from ServiceNow
steps:
  - type: action
    name: getIncident
    action: serviceNow.incident.get
    version: 1
    inputs:
      domain: "your-domain"
      apiKey: "${{ :secrets:serviceNowApiKey }}"
      sysId: "ed59ab193b67ba10e811026aa5e45a2d"
      parameters:
        sysparm_fields: "number,short_description,description,priority"
      selectors:
        - name: sysId
          expression: .responseBody.result.sys_id
    next: end