Skip to main content
ServiceNow logo
  • Category: it operations
  • Auth: BASIC, OAUTH2, S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 171
  • Triggers: 0
  • Slug: SERVICENOW
  • Version: 20261101_00

Tools

Slug: SERVICENOW_ATTACH_FILE_TO_RECORDAttaches a file to a specified record in a ServiceNow table. This action uploads a file and associates it with a specific record (e.g., incident, problem, change request). The file will be visible in the ServiceNow UI under the record’s attachments section. Common use cases: - Attach screenshots to incident reports - Upload documents to change requests - Add log files to problem records - Store evidence files for security incidents The action returns complete attachment metadata including download link, file size, and creation details. Note: This action permanently modifies a live ServiceNow instance — attachments cannot be bulk-removed once added.

Input Parameters

string
required
Name to give the attachment (e.g., ‘report.pdf’, ‘screenshot.png’). This will be the visible filename in ServiceNow.
string
required
Name of the ServiceNow table to attach the file to (e.g., ‘incident’, ‘problem’, ‘change_request’).
string
Creation date and time of the attachment. Use this parameter to capture attachment creation times when the Now Mobile app is offline and the attachment is uploaded to a record at a later time.
string
required
Sys_id of the specific record in the table to attach the file to. This is the unique identifier of the record (e.g., incident sys_id).
object
required
File to upload.
string
Sys_id of an encryption context record. Specify this parameter to allow only users with the specified encryption context to access the attachment. For additional information on encryption context records, see https://www.servicenow.com/docs/csh?topicname=column-level-encryption-landing&version=yokohama&pubname=yokohama-platform-security.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CANCEL_CHANGE_CONFLICT_CHECKCancels the running conflict checking process for a specified ServiceNow change request. Use this action when a conflict check is taking too long or needs to be aborted, and you want to stop the process without waiting for it to complete naturally. This is commonly used when automated change management workflows need to be expedited or when conflict checks are blocking other operations. Note: this action is NOT idempotent. Calling it on a change request with no active conflict check running returns a 400 error (“Conflict for change request could not be cancelled”), not a success response. If the change request doesn’t exist, a 404 error is returned instead.

Input Parameters

string
required
The unique system ID (sys_id) of the change request whose conflict checking process should be cancelled. This is a 32-character hexadecimal string that uniquely identifies the change request record. Example: ‘1766f1de47410200e90d87e8dee490f6’. The change request must exist and have an active conflict checking process running.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_A_RECORDCreates a new record in a specified ServiceNow table with the provided field values. The response contains the created record, subject to the requested field selection and view.

Input Parameters

string
required
The name of the table where the record will be created (e.g., ‘incident’, ‘problem’, ‘change_request’, ‘sys_user’).
object
Field-value pairs for the new record. Available fields depend on the table schema. For ‘incident’ table, common fields include: ‘short_description’, ‘description’, ‘urgency’ (1-3), ‘impact’ (1-3), ‘priority’, ‘assignment_group’, ‘assigned_to’, ‘category’, ‘state’. For reference fields (like ‘assignment_group’ or ‘assigned_to’), use the sys_id of the referenced record, or set sysparm_input_display_value=true to use display values. Example: {‘short_description’: ‘Network outage’, ‘urgency’: ‘1’, ‘impact’: ‘1’, ‘description’: ‘Unable to access network’}
string ("desktop" | "mobile" | "both")
UI view to determine which fields are returned in the response. If not specified, returns fields from the default view.
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state’). Invalid fields are ignored. If not specified, all fields are returned.
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
boolean
Set to true if providing display values (e.g., user names) instead of sys_ids in record_data for reference fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_ATTACHMENT_UPLOADUploads a file as a multipart form-data attachment to a specified record in ServiceNow. Use this action when you need to attach files to ServiceNow records (e.g., incidents, problems, change requests) using the multipart form-data upload endpoint. This action sends the file as a multipart/form-data request with the table name, table sys_id, and file content. Common use cases: - Attach documents or screenshots to incident reports - Upload evidence files to problem records - Add files to change requests for documentation The action returns complete attachment metadata including the sys_id, download link, file size, and creation details. This action permanently modifies a live ServiceNow instance — the attachment cannot be recovered once deleted.

Input Parameters

string
required
Name of the ServiceNow table to attach the file to (e.g., ‘incident’, ‘problem’, ‘change_request’).
string
required
Sys_id of the record to attach the file to. This is the unique identifier of the record.
string
required
File to upload. Can be either an uploaded file or a FileContent object with direct content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_CILIFECYCLEMGMT_ACTIONAdds a specified configuration item (CI) action using the ServiceNow CI Lifecycle Management API. Use this action when you need to create or execute a CI lifecycle action for a Configuration Item in ServiceNow’s CMDB. This endpoint allows you to trigger specific lifecycle actions (such as activate, retire, or custom actions) on CIs programmatically. The action requires the CI identifier and the action name to be executed. Ensure the action is valid for the specified CI class.

Input Parameters

string
required
The unique identifier of the Configuration Item (CI) to associate with the action. This can be the sys_id (32-character hexadecimal string) or other CI identifier. Example: ‘00a96c0d3790200044e0bfc8bcbe5db4’
string
required
The name or identifier of the action to execute on the CI. This corresponds to a valid CI lifecycle action defined in the ci_lifecycle_action table. Example: ‘test_action’, ‘activate’, ‘retire’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_CI_LIFECYCLE_MGMT_OPERATORSRegisters a new operator for a non-workflow user in the ServiceNow CI Lifecycle Management system. Use this action when you need to create or register an operator identity for CI lifecycle management purposes. The operator must be associated with a non-workflow user account. The returned req_id can be used to manage the operator (e.g., delete it later).

Input Parameters

string
required
The email address of the operator. Must be a valid email format. Example: ‘test@example.com’
string
required
The last name (surname) of the operator. Example: ‘Operator’
string
required
The unique username for the operator being registered. This must be a non-workflow user account. Example: ‘test_operator’
string
required
The first name of the operator. Example: ‘Test’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_CI_LIFECYCLE_MGMT_STATUSESSets the operational state for one or more configuration items (CIs) using the ServiceNow CI Lifecycle Management API. Use this action when you need to update the operational status of CIs in ServiceNow’s CMDB. This endpoint allows you to programmatically set the operational state (operational, non-operational, on order, inventory, etc.) for a batch of configuration items. The action requires a list of CI identifiers and the operational state value to apply.

Input Parameters

array
required
List of Configuration Item (CI) identifiers to set the operational state for. Each identifier should be the sys_id (32-character hexadecimal string) of the CI. Example: [‘73aa7167c42’] or [‘00a96c0d3790200044e0bfc8bcbe5db4’]
string
The user ID or sys_id of the requestor who is setting the operational state. This is required for authorization purposes. Example: ‘admin’ or ‘681ccaf9c0a8016400b98a06818d6e1a’
string
required
The operational state to set for the specified CIs. Common values: ‘1’ = Operational, ‘2’ = Non-Operational, ‘3’ = On Order, ‘4’ = Inventory. The valid values depend on your ServiceNow configuration. Example: ‘1’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_CMDB_APP_SERVICECreates an application service in ServiceNow CMDB or updates an existing one if a service with the same name already exists. Use this action when you need to register a new application service in the Configuration Management Database (CMDB). This endpoint performs a create-or-update operation: if an application service with the specified name already exists, it will be updated with the provided values rather than creating a duplicate.

Input Parameters

string
required
Name of the application service to create. If an application service with the same name already exists, it will be updated with the provided values.
integer
Display order for the application service. Used when ordering or sorting application services in lists or UIs.
string
Tenant identifier for the application service. Used in multi-tenant deployments to scope the application service to a specific tenant.
string
Description of the application service providing details about its purpose and functionality.
string
Business owning segment for the application service. Defines the organizational segment that owns and is responsible for this application service.
string
Operational status of the application service (e.g., ‘Production’, ‘Development’, ‘Retired’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_CMDB_CI_LINUX_SERVERCreates a Linux server configuration item in the ServiceNow cmdb_ci_linux_server table with the supplied attributes. The response can be restricted to selected fields.

Input Parameters

string
Operating system name and version for the Linux server. Common values include: ‘Linux Red Hat’, ‘Linux Ubuntu’, ‘Linux CentOS’, ‘Linux SUSE’, ‘Linux Debian’, ‘Red Hat Enterprise Linux 7’, ‘Ubuntu Server 22.04 LTS’. Example: ‘Linux Red Hat’, ‘Linux Ubuntu’, ‘Red Hat Enterprise Linux 8’
integer
Total RAM in megabytes (MB) installed on the Linux server. Example: 16384 (for 16GB), 32768 (for 32GB)
string
Fully Qualified Domain Name (FQDN) of the Linux server. Example: ‘web-server-01.example.com’
string
required
Name of the Linux server configuration item. This is the primary display name used to identify the server in the CMDB and ServiceNow UI. Example: ‘prod-web-server-01’, ‘test-linux-final’
string
Vendor or reseller from whom the server or software was purchased. Example: ‘Dell’, ‘HP’, ‘Lenovo’, ‘AWS’
string
Physical or logical location of the Linux server. Can be a data center name, building, rack location, or cloud region. Example: ‘US-East-1’, ‘DC1-Rack-A12’, ‘Building A - Floor 3’
string
Hardware or virtual machine model identifier. Example: ‘PowerEdge R740’, ‘VMware Virtual Platform’, ‘m5.large’
integer
Number of CPU cores or processors installed on the Linux server. Example: 4, 8, 16
string
Fully qualified or short hostname of the Linux server as reported by the OS. This is typically the value returned by the ‘hostname’ command. Example: ‘web-server-01’, ‘test-final.example.com’
integer
Total disk space in megabytes (MB) allocated to the Linux server. Example: 512000 (for 500GB)
string
Primary IP address of the Linux server. Supports both IPv4 and IPv6 formats. Example: ‘192.168.1.200’, ‘10.0.0.1’, ‘2001:db8::1’
string
Name or sys_id of the person or group responsible for managing this server. Set sysparm_input_display_value=true to use display names instead of sys_ids.
string
sys_id or display name of the user assigned primary responsibility for this server. Set sysparm_input_display_value=true to use display names instead of sys_ids.
string
Cost center identifier or name responsible for the financial aspects of this server. Example: ‘CC-00123’, ‘IT Operations’
string
Detailed description of the Linux server providing context about its purpose, configuration, or any relevant notes. Example: ‘Production web server running RHEL 8 with Apache’
string
Environment classification for the Linux server. Common values: ‘Development’, ‘Test’, ‘Production’, ‘Staging’. Example: ‘Production’, ‘Development’
string
Primary MAC (Media Access Control) address of the server’s network interface. Format: six pairs of hexadecimal digits separated by colons or hyphens. Example: ‘00:50:56:C0:00:08’, ‘00-50-56-c0-00-08’
string
Manufacturer or vendor of the Linux server hardware or virtualization platform. Example: ‘VMware Inc.’, ‘Dell Inc.’, ‘HP’, ‘Amazon Web Services’
string
Date when the server hardware or license was purchased. Format: YYYY-MM-DD. Example: ‘2023-01-15’
string
Hardware serial number of the Linux server as assigned by the manufacturer. Example: ‘SN-12345ABCDE’, ‘VMware-42 00 00 00 00 00 00 00-00 00 00 00 00 00 00 00’
string
Name of the group responsible for providing support for this server. Example: ‘L2 Linux Support’, ‘NOC’
integer
Total number of CPU cores (sockets times cores per socket) on the server. Example: 32, 64
string
Installation status of the Linux server. Common values: ‘1’ = Installed, ‘2’ = On Order, ‘3’ = In Maintenance, ‘4’ = Pending Installation, ‘5’ = Pending Return, ‘7’ = Absent. Example: ‘1’ (Installed)
string
Linux kernel version running on the server. Example: ‘5.4.0-150-generic’, ‘3.10.0-1160.el7.x86_64’
string
Comma-separated list of fields to return in the response (e.g., ‘sys_id,name,ip_address’). Invalid fields are ignored. If not specified, all fields are returned.
string
sys_id or display name of the group assigned to manage this server. Set sysparm_input_display_value=true to use display names instead of sys_ids.
string
Source of the discovery data for this CI. Common values include: ‘Manual Entry’, ‘ServiceNow Discovery’, ‘LDAP’, ‘Import Set’, ‘MID Server’, ‘ECMDB’. If not specified, defaults to ‘Manual Entry’. Example: ‘Manual Entry’, ‘ServiceNow Discovery’
string
Operating system architecture bit-width. Common values: ‘32-bit’, ‘64-bit’. Example: ‘64-bit’
string
Operational status of the Linux server. Common values: ‘1’ = Operational, ‘2’ = Non-Operational, ‘3’ = Being Installed, ‘4’ = Being Repaired, ‘6’ = Under Maintenance. Example: ‘1’ (Operational)
string
Date when the server warranty expires. Format: YYYY-MM-DD. Example: ‘2026-01-15’
string
Determines the type of data returned in the response. ‘false’: Returns actual database values (default). ‘true’: Returns display values. ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_CMDB_INGESTInserts multiple records into a ServiceNow Import Set staging table. Use this action when you need to bulk-import configuration items (CIs) or other data into ServiceNow via an Import Set. Records are inserted into the specified staging table, which is processed by the associated transform map to load data into the target table (e.g., CMDB tables like cmdb_ci_server). The staging table name identifies the import set staging table (e.g., ‘sys_import_set_row’), and the transform map associated with that table determines how each record is transformed. Note: Records are inserted into the Import Set staging table and will be transformed to the target table via the configured transform map.

Input Parameters

array
required
Array of record objects to insert into the Import Set staging table. Each record should contain field-value pairs that match the columns of the staging table. Common fields include: ‘name’, ‘ip_address’, ‘mac_address’, ‘serial_number’, ‘host_name’, etc. Example: [{‘name’: ‘test_server’, ‘ip_address’: ‘192.168.1.100’}]
string
required
Name of the import set staging table to insert records into. Examples: ‘sys_import_set_row’, ‘u_cmdb_ci_staging’, ‘sys_import_tst_abc123’. This is a path parameter that identifies the staging table for the import set. The staging table is determined by the transform map configuration.
boolean
Set to true if providing display values instead of sys_ids for reference fields in the records. When false (default), reference fields must contain sys_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_CMDB_INSTANCECreates one record with the supplied attributes in a specified ServiceNow table using the Table API. It can be used to register a configuration item in a CMDB class table.

Input Parameters

string
required
The name of the CMDB class for the configuration item (CI) to create. Common CI classes include: ‘cmdb_ci’ (generic CI), ‘cmdb_ci_server’, ‘cmdb_ci_database’, ‘cmdb_ci_network_adapter’, ‘cmdb_ci_storage_device’, ‘cmdb_ci_service_discovered’, ‘cmdb_ci_hardware’, ‘cmdb_ciPrinter’, etc. Use the full class name without ‘u_’ prefix for base classes.
object
required
A dictionary of attribute name-value pairs for the CI. The available attributes depend on the specified class. Common attributes across many CI classes include: ‘name’ (CI display name), ‘serial_number’, ‘ip_address’, ‘mac_address’, ‘host_name’, ‘fqdn’, ‘manufacturer’, ‘model_id’, ‘vendor’, ‘purchase_date’, ‘assigned_to’, ‘assignment_group’, ‘location’, ‘support_group’, ‘managed_by’, ‘operational_status’, ‘install_status’, ‘cost’, ‘cost_center’, ‘u_custom_attribute’. Example: {‘name’: ‘Production Server 01’, ‘serial_number’: ‘SN-12345’, ‘ip_address’: ‘192.168.1.100’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_CMDB_INSTANCE_RELATIONCreates an inbound and/or outbound relation for a specific configuration item (CI) in the ServiceNow CMDB. Use this action when you need to establish relationships between configuration items in the CMDB, such as indicating that a server ‘runs on’ hardware, a service ‘depends on’ a database, or an application ‘hosts’ middleware components. This action adds relations to the specified CI (identified by classname and sys_id) without modifying the CI itself. Relations are bidirectional in the CMDB - adding an outbound relation from CI A to CI B also creates a corresponding inbound relation on CI B. Common use cases: Building CMDB relationship maps, establishing application dependencies, defining infrastructure hierarchies, or documenting service relationships.

Input Parameters

string
required
The sys_id of the source configuration item to add relations to. This is a 32-character hexadecimal string. Example: ‘12345678901234567890123456789012’
string
required
The CMDB class name for the configuration item (e.g., ‘cmdb_ci’, ‘cmdb_ci_server’, ‘cmdb_ci_service’). This is the table name that defines the type of CI.
array
List of inbound relations to create to this CI from other CIs. Inbound relations represent relationships where other CIs are the source. Each item’s type must be a cmdb_rel_type sys_id (see ListCmdbRelTypes), not a display label like ‘Used by::Depends on’.
array
List of outbound relations to create from this CI to other CIs. Outbound relations represent relationships where this CI is the source. Each item’s type must be a cmdb_rel_type sys_id (see ListCmdbRelTypes), not a display label like ‘Depends on::Used by’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_DATA_CLASSIFICATION_CLASSIFYAssigns pre-defined or user-defined data classifications to existing dictionary entries. Use this action when you need to classify sensitive or confidential table columns according to your organization’s data governance policies. This action classifies Dictionary [sys_dictionary] entries (table.column metadata) — not individual records — by assigning them one or more Data Classification [data_classification] labels such as ‘Public’, ‘Internal’, ‘Confidential’, or custom labels defined on the instance. Requires the admin or data_classification_admin role.

Input Parameters

array
required
Sys_ids of the Data Classification [data_classification] records to assign to every dictionary entry listed in dictionary_entries. Example: [‘40edb1f51bbcec50b92a10a61a4bcb8a’]
array
required
Sys_ids of the Dictionary [sys_dictionary] records (table.column entries) to classify. Not record sys_ids — these must be sys_dictionary entries, e.g. the sys_id of the incident.caller_id dictionary entry. Example: [‘445de0a6dba30300efc57416bf9619b0’]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_DATA_CLASSIFICATION_CLEARRemoves all data classifications for a specific record in a ServiceNow table. Use this action when you need to clear/reset data classification labels from a record, such as when reclassifying sensitive data, removing outdated classifications, or preparing records for re-processing. This action clears all data classification entries associated with the specified record. Note: This operation may require appropriate ServiceNow permissions. If the user lacks permission to modify data classifications on the specified table, an error will be returned.

Input Parameters

string
required
The unique system ID (sys_id) of the record whose data classifications should be cleared. This is a 32-character hexadecimal string that uniquely identifies the record. Example: ‘abc1234567890abcdef1234567890ab’
string
required
The name of the ServiceNow table containing the record whose data classifications should be cleared. Examples: ‘incident’, ‘problem’, ‘change_request’, ‘task’, ‘sc_request’. The table must exist in the ServiceNow instance and contain data classification fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_IDENTIFYRECONCILE_ENHANCEDInserts or updates configuration items (CIs) in ServiceNow CMDB using the enhanced Identification and Reconciliation API. Use this action when you need to bulk-insert or update multiple configuration items in the CMDB, with automatic identification of existing CIs based on identifying attributes (name, IP address, serial number, MAC address, hostname, or sys_id) and optional creation of CI relationships. This API provides better error handling and detailed per-item results compared to basic CMDB instance APIs. This action is useful for CMDB data population, reconciliation of discovered CIs against the CMDB, bulk CI updates, and establishing CI relationships during discovery or import workflows.

Input Parameters

array
required
Array of configuration item (CI) objects to insert or update in the CMDB. Each item must have at least one identifying field (name, class_name, sys_id, ip_address, serial_number, mac_address, or host_name) to match an existing CI. If no existing CI matches, a new CI is created. The ‘attributes’ dict can be used to set or update CMDB fields on matched CIs. Example: [{‘name’: ‘Server 01’, ‘className’: ‘cmdb_ci_server’, ‘ip_address’: ‘192.168.1.100’, ‘attributes’: {‘operational_status’: ‘1’}}]
array
Array of relationship objects to create between CIs. Relationships are directional, defined as ‘Source::Target’ format. Each relation requires source and target CI identification (via sys_id, link, or name). Relations are processed after CIs. Example: [{‘type’: ‘Runs on::Runs’, ‘source’: {‘name’: ‘App Server’}, ‘target’: {‘name’: ‘DB Server’}}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_IDENTIFYRECONCILE_QUERYQueries the ServiceNow Identify and Reconcile API to determine whether a Configuration Item (CI) should be inserted (created) or updated in the CMDB based on identity matching rules. Use this action when you need to check whether a CI already exists in the CMDB before creating or updating it, or when you want ServiceNow to automatically determine the correct operation (INSERT vs UPDATE) based on configured identity matching rules and the provided attributes. This is commonly used during data migration, discovery integration, or bulk CI reconciliation workflows where the operation (create vs update) needs to be determined programmatically. Note: This action performs a query/reconciliation check only — it does not execute the actual INSERT or UPDATE operation. It returns the recommended operation and the matched CI details.

Input Parameters

string
required
The name of the data source that identifies the origin of the CI data being reconciled. This is used by ServiceNow to determine which reconciliation rules and identity matching rules apply. The source must be a valid data source configured in ServiceNow (e.g., ‘cmdb_azure’, ‘cmdb_aws’, ‘test_source’). Example: ‘cmdb_azure’
object
required
A dictionary of attribute name-value pairs used to identify or match an existing CI. ServiceNow uses these attributes along with identity matching rules to determine whether an existing CI matches (triggering an update) or no match exists (triggering an insert). Common identifying attributes include: ‘name’ (CI display name), ‘serial_number’, ‘ip_address’, ‘mac_address’, ‘host_name’, ‘fqdn’, ‘asset_tag’. Example: {‘name’: ‘Test Server’, ‘ip_address’: ‘192.168.1.100’}
string
required
The name of the CMDB class for the configuration item (CI) to identify/reconcile. Common CI classes include: ‘cmdb_ci’ (generic CI), ‘cmdb_ci_server’, ‘cmdb_ci_database’, ‘cmdb_ci_network_adapter’, ‘cmdb_ci_storage_device’, ‘cmdb_ci_service_discovered’, ‘cmdb_ci_hardware’, ‘cmdb_ciPrinter’, ‘cmdb_ci_application’, etc. Example: ‘cmdb_ci’
string
Determines the format of field values in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_IDENTIFYRECONCILE_QUERYENHANCEDPerforms identification and reconciliation of configuration items (CIs) in the ServiceNow CMDB. Use this action when you need to determine whether to insert a new CI or update an existing one based on matching attributes. The API compares the provided data against existing CIs and returns the recommended operation (insert/update) along with the matched or created CI details. This is useful for data imports, discovery integration, or synchronizing CI data from external sources. Note: When dry_run is false (default), this action may create or modify existing CIs in the CMDB.

Input Parameters

object
required
A dictionary containing the configuration item (CI) attributes to reconcile. The available attributes depend on the CMDB class. Common attributes include: ‘name’ (CI display name, often required), ‘u_class’ or ‘sys_class_name’ (CMDB class), ‘serial_number’, ‘ip_address’, ‘mac_address’, ‘host_name’, ‘fqdn’, ‘manufacturer’, ‘model_id’, ‘vendor’, ‘operational_status’, ‘install_status’. The API uses these attributes to match against existing CIs in the CMDB. Example: {‘name’: ‘Production Server 01’, ‘u_class’: ‘cmdb_ci_server’, ‘ip_address’: ‘192.168.1.100’}
string
required
The source identifier for the reconciliation query. This identifies the data source or integration point that is providing the CI data. Examples: ‘cmdb_import_set’, ‘discovery’, ‘manual’, or a custom integration name.
boolean
When set to true, performs a simulation without actually creating or updating any CIs. Useful for previewing what changes would be made before committing. Default is false, meaning changes will be applied.
string
The type of reconciliation to perform. Determines how the API matches incoming data against existing CIs. Common values: ‘exact’ (exact match on all specified fields), ‘fuzzy’ (partial match), or ‘identify’ (identification only without creating/updating). If not specified, uses the default reconciliation behavior configured in ServiceNow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_IMPORTSubmits incoming data to a specified ServiceNow import staging table for transformation into a target table. Although the request accepts a list of items, ServiceNow processes only the first record in a POST containing multiple records.

Input Parameters

array
required
List of data objects to import into the staging table. Each object contains field-value pairs corresponding to the columns in the staging table. The fields must match the columns defined in the staging table schema. Example: [{‘short_description’: ‘Test item’, ‘description’: ‘Import test’}]. The data will be inserted into the staging table and the transform map associated with the staging table will be triggered to move data to the production table.
string
required
Name of the import set staging table to insert data into. This is the name of a staging table (usually prefixed with ‘u_’) that is configured with a transform map to move data into a production table. Common staging table names include: ‘u_test_import_set’, ‘u_incident_staging’, ‘u_cmdb_ci_staging’, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_INCIDENTCreates a new incident in ServiceNow with supplied incident fields, including urgency, impact, state and caller. The response can be restricted to selected fields.

Input Parameters

string ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8")
ServiceNow incident state values
boolean
Whether the incident is active. Defaults to true for new incidents.
string ("1" | "2" | "3" | "4")
ServiceNow impact levels - measures of business criticality
string
Configuration Item (CI) in the CMDB that is affected.
string ("1" | "2" | "3" | "4")
ServiceNow urgency levels - measure of business criticality
string
Category classification of the incident (e.g., ‘Network’, ‘Hardware’, ‘Software’, ‘Database’).
string
Additional comments about the incident, visible to end users.
string
Location of the caller or affected service.
string ("1" | "2" | "3" | "4" | "5")
ServiceNow priority levels
string
Person who reported or is affected by the incident. Can be a user sys_id or display value depending on sysparm_input_display_value setting.
string
Internal work notes about the incident, not visible to end users.
string
Person primarily responsible for working this incident. Can be a user sys_id or display value.
string
Detailed description of the incident, including symptoms, steps to reproduce, and any relevant context.
string
Subcategory within the main category (e.g., ‘Firewall’ under ‘Network’).
string
Method of contact used to report the incident (e.g., ‘Phone’, ‘Email’, ‘Self-service’, ‘Chat’).
string
Comma-separated list of fields to return in the response (e.g., ‘number,sys_id,short_description,state’). Invalid fields are ignored. If not specified, all fields are returned.
string
Group assigned to handle the incident. Can be a group sys_id or display value.
string
Business service affected by the incident.
string
required
Brief summary of the incident. This field is required for most incident records.
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
boolean
Set to true if providing display values (e.g., user names, group names) instead of sys_ids in caller_id, assigned_to, assignment_group, or other reference fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response. This is recommended for cleaner responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_INTERACTIONCreates a ServiceNow interaction using a short description, message, table name and channel, with optional caller, assignment, priority and state fields.

Input Parameters

string
Current state of the interaction (e.g., ‘open’, ‘in_progress’, ‘closed’, ‘pending’).
string ("api" | "phone" | "email" | "chat" | "portal" | "mobile" | "self_service")
The channel through which the interaction was initiated. Defaults to ‘api’ if not specified.
string
required
The main message or content of the interaction. This is a required field.
string
Priority level of the interaction (e.g., ‘1’ for critical, ‘2’ for high, ‘3’ for normal, ‘4’ for low).
string
sys_id of the user who initiated the interaction. If not provided, the interaction will be created with the authenticated user’s information.
string
required
The name of the table to link the interaction to (e.g., ‘incident’, ‘problem’, ‘task’, ‘sn_customerservice_case’). This determines what record type the interaction is associated with.
string
sys_id of the user to assign the interaction to.
string
sys_id of the group to assign the interaction to.
string
required
A brief summary or title describing the interaction. This is a required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_INTERACTION_CLOSECloses an existing interaction record in ServiceNow by changing its state to closed. Use this action when you need to close or finalize an interaction that has been completed or resolved. This action changes the state of the interaction record to indicate that it is no longer active. Note: The interaction must be in a state that allows closing (e.g., not already closed). This action is typically used after an interaction has been handled and resolved. The body of the POST request can optionally include fields like ‘state’, ‘opened_for’, ‘resolution_code’, and ‘resolution_notes’ to provide additional context about the closure.

Input Parameters

string
The state to set for the interaction when closing. Typically this would be a closed state value (e.g., ‘closed’, ‘resolved’). If not provided, the default closed state from the system will be used.
string
The sys_id of the user or entity for whom the interaction was originally opened. This field is used to track and attribute the interaction. Example: ‘681ccaf9c0a8016400b98fa0d0232157’
string
required
The unique system ID (sys_id) of the interaction record to close. This is a 32-character hexadecimal string that uniquely identifies the interaction record. Example: ‘87e3c4fa837bf210dd2dc2dfeeaad397’
string
Code indicating how the interaction was resolved. Common values include: ‘resolved’, ‘escalated’, ‘transferred’, ‘cancelled’. This helps categorize the closure reason.
string
Notes documenting the resolution of the interaction. This field is used to provide details about how the interaction was handled and closed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_PUSH_INSTALLATIONRegisters or updates a device token for receiving push notifications through ServiceNow. Use this action when you need to register a mobile device token with ServiceNow’s push notification system, enabling the device to receive push notifications from ServiceNow mobile apps. The action creates a new push installation or updates an existing one if the same token already exists for the specified push application. Common use cases: - Registering iOS devices for APNS push notifications - Registering Android devices for FCM push notifications - Updating existing device tokens when they change (token refresh) - Linking devices to specific ServiceNow users This action modifies the ServiceNow push notification registry — registered devices will be eligible to receive push notifications from ServiceNow.

Input Parameters

string
required
The device token obtained from Apple Push Notification Service (APNS) for iOS devices or Firebase Cloud Messaging (FCM) for Android devices. This token identifies the device to receive push notifications.
string
The sys_id of the ServiceNow user associated with this device token. This links the device to a specific user for user-specific push notifications.
string ("Apple" | "Android")
required
The mobile platform for the device token. Use ‘Apple’ for iOS devices (APNS) or ‘Android’ for Android devices (FCM).
string
The type of the mobile device (e.g., ‘phone’, ‘tablet’). This field is optional and helps categorize devices for targeted notifications.
string
A unique identifier for the subscription. If not provided, a new subscription will be created or an existing one with the same token will be updated.
string
required
The name of the push application in ServiceNow (e.g., ‘SkyNowPushApp’). This corresponds to the push application record configured in ServiceNow for handling push notifications to mobile devices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_PUSH_REMOVE_INSTALLATIONDeactivates a mobile device installation from receiving push notifications using the ServiceNow Push Installation API. Use this action when you need to remove a mobile device’s ability to receive push notifications from a ServiceNow push application. This effectively deactivates the device token that enables communication between ServiceNow and the mobile app on the specified device. This is commonly used when: - A user uninstalls the mobile app from their device - A device needs to be unregistered from push notifications - Managing device registrations for push notification campaigns Note: This action only deactivates the device token - it does not delete any data from ServiceNow.

Input Parameters

string
required
The unique device token that identifies the mobile device installation to remove. This token is assigned to a device when it registers with ServiceNow for push notifications. Deactivating this token will prevent the device from receiving push notifications from this application. Example: ‘fcm_token_abc123’ or ‘apns_token_xyz789’
string ("Apple" | "Android")
required
The mobile platform for the device token. Use ‘Apple’ for iOS devices (APNS) or ‘Android’ for Android devices (FCM).
string
required
The name of the push application whose device installation should be removed/deactivated. This is a path parameter in the URL, not a body parameter. The push application name identifies the mobile app configuration in ServiceNow. Example: ‘ServiceNowPushApp’ or ‘snc_mobile_app’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SERVIC_CATALOG_ITEMS_ADD_TO_CARTAdds a specified catalog item to the current user’s ServiceNow shopping cart. Use when a user wants to order or request a specific item from the Service Catalog, such as requesting a laptop, software license, or IT service. The item is added to the user’s active shopping cart and can be reviewed or submitted in a later step. Note: The action operates on the authenticated user’s cart. If the catalog item requires mandatory variables, they must be provided in the variables field, otherwise the request may fail.

Input Parameters

string
required
The unique system ID (sys_id) of the catalog item to add to the cart. This is a 32-character hexadecimal string that identifies the specific catalog item in ServiceNow. Example: ‘039c516237b1300054b6a3549dbe5dfc’. This is a required path parameter.
object
Key-value pairs of catalog item variables to set when adding to cart. The variable names and expected values depend on the specific catalog item’s variable definitions. For example, if the item has a ‘model’ variable, you might pass {‘model’: ‘Laptop Model X’}. Omit this field if the catalog item does not require any variables.
integer
The number of units of the catalog item to add to the shopping cart. Defaults to 1 if not specified. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SERVIC_CATALOG_ITEMS_SUBMIT_PRODUCERSubmits a Service Catalog producer item with optional variables to create a record in ServiceNow. The response can include the created record’s sys_id, table name and number.

Input Parameters

string
required
The unique system ID (sys_id) of the catalog item to submit. This is a 32-character hexadecimal string that identifies the service catalog item. Example: ‘011f117a9f3002002920bde8132e7020’. You can find the sys_id by listing catalog items or navigating to the item in ServiceNow.
object
A dictionary of catalog item variable name-value pairs to provide during submission. These are the variables defined on the catalog item that the user fills out when submitting. The variable names must match exactly as defined in the catalog item. Example: {‘short_description’: ‘New laptop request’, ‘urgency’: ‘high’, ‘std_change_producer’: ‘508e02ec47410200e90d87e8dee49058’}
string
Determines the type of data returned in the response. ‘true’: Returns display values (names for references, text labels for choices). ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘all’: Returns both display and actual values. If not specified, defaults to the instance setting.
boolean
Set to true to skip variable validation during submission. When false (default), ServiceNow validates all required variables before accepting the submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SERVICE_CATALOG_CART_CHECKOUTChecks out the Service Catalog shopping cart and submits the order as a request. This action retrieves the items in the cart, creates a service catalog request, deletes the cart contents, and returns the request ID and number for tracking. The cart is emptied after successful checkout. This action is irreversible once the checkout is completed — the order has been submitted and cannot be cancelled through this action. Use this action when you need to finalize a Service Catalog order by submitting all items in the shopping cart for processing and approval.

Input Parameters

string
The unique system ID (sys_id) of the Service Catalog shopping cart to checkout. This is a 32-character hexadecimal string that uniquely identifies the cart record. Example: ‘cart_sys_id’. If not provided, the current user’s default cart will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SERVICE_CATALOG_CART_SUBMIT_ORDERSubmits the Service Catalog shopping cart and creates a service catalog request. This action checks out the user cart, creates a service catalog request with all items in the cart, and returns the request ID and number for tracking. The cart contents are converted into a submitted order. This action is irreversible once submitted — the order has been created and cannot be cancelled through this action. Use this action when you need to finalize a Service Catalog order by submitting all items in the shopping cart for processing and approval. This is typically called after items have been added to the cart using other cart operations.

Input Parameters

string
The unique system ID (sys_id) of the Service Catalog shopping cart to submit. This is a 32-character hexadecimal string that uniquely identifies the cart record. Example: ‘cart_sys_id’. If not provided, the current user’s active cart will be used.
integer
The quantity of items to order. If specified, applies to all items in the cart. Defaults to 1 if not specified.
object
Dictionary of catalog item variables (answers) to set during submission. The keys should be the variable IDs (not the labels) as defined in the catalog item. Example: {‘reason’: ‘New laptop needed’, ‘location’: ‘NYC’}
boolean
Set to true to ignore price changes that may have occurred since items were added to cart. When false (default), the order may fail if prices have changed.
string
The user ID (sys_id or username) to submit the order on behalf of. Use this parameter when submitting an order for another user. Example: ‘requested_for_sys_id’ or ‘john.doe’
boolean
Set to true to suppress warnings when required attachments are missing. The order will still be submitted even if warnings would normally be generated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SERVICECATALOG_ITEMS_CHECKOUT_GUIDEChecks out a ServiceNow Service Catalog order guide by sys_id with the supplied variable values. The response is shaped as cart details, including a cart ID and pricing fields when available.

Input Parameters

string
required
The unique system ID (sys_id) of the order guide to check out. This is a 32-character hexadecimal string that uniquely identifies the order guide item. Example: ‘25110912372211003e7d40ed9dbe5dd6’. The order guide must be active and available in the Service Catalog.
object
Variable values for all selected catalog items within the order guide. Keys are the variable names/IDs and values are the corresponding values to set. The required variables depend on the specific order guide configuration. Common variable types include text inputs, checkboxes, dropdowns, and reference fields. All values should be provided as strings. Example: {‘requested_for’: ‘2024-01-15’, ‘quantity’: ‘1’, ‘urgency’: ‘high’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SERVICECATALOG_ITEMS_ORDER_NOWOrders a specified ServiceNow Service Catalog item immediately. This action submits an order for a catalog item without requiring cart checkout. The item is ordered directly with the specified quantity and optional variables. Use this action when you need to quickly order a known catalog item for a user. Use when you have a catalog item’s sys_id and want to order it directly without adding it to a cart first. This action is useful for automated provisioning of standard items like laptop requests, software access, or access cards.

Input Parameters

string
required
The unique system ID (sys_id) of the catalog item to order. This is a 32-character hexadecimal string that identifies the service catalog item. Example: ‘04b7e94b4f7b4200086eeed18110c7fd’. You can find the sys_id by listing catalog items or navigating to the item in ServiceNow.
object
A dictionary of catalog item variable name-value pairs to provide during ordering. These are the variables defined on the catalog item that the user fills out at order time. The variable names must match exactly as defined in the catalog item. Example: {‘reason’: ‘New laptop needed’, ‘urgency’: ‘high’}
integer
The number of instances of the catalog item to order. Must be a positive integer. Defaults to 1 if not specified.
string
The user ID (sys_id) of the person for whom the item is being ordered. If not specified, the item is ordered for the current user. Example: ‘681ccaf9c0a8016400b98a06818d57a7’ (sys_id of a user).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SERVICENOW_IMPORT_INSERTMULTIPLEInserts multiple records into a specified ServiceNow staging table and triggers the associated transform map. Use this action when you need to bulk-import data into ServiceNow via an Import Set. Records are inserted into the specified staging table, then processed by the transform map which maps staging fields to target table fields. This provides improved scalability and stability over inserting records one at a time. The staging table name identifies the import set staging table (e.g., ‘sys_import_set_row’), and the transform map associated with that table determines how each record is transformed and loaded into the target table.

Input Parameters

array
required
Array of record objects to insert into the staging table. Each record contains field-value pairs matching the columns of the staging table. These records will be queued for transform based on the transform map associated with the staging table. Example: [{‘short_description’: ‘Test record 1’}, {‘short_description’: ‘Test record 2’}]
string
required
Name of the import set staging table to insert records into. Examples: ‘sys_import_set_row’, ‘u_staging_incident’, ‘sys_import_tst_abc123’. This is a path parameter that identifies the staging table.
boolean
Set to true if providing display values instead of sys_ids for reference fields in the records. When false (default), reference fields must contain sys_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CHG_REST_CHANGECreates a new change request in ServiceNow using the Change Management REST API. Use this action when you need to create and submit a new change request for approval and implementation. The action supports specifying change details such as short description, description, category, type, priority, risk, and impact. After creation, the change request will have a unique sys_id and number that can be used to retrieve, update, or delete it in subsequent operations.

Input Parameters

string
Risk level of the change request (e.g., ‘low’, ‘medium’, ‘high’, ‘critical’).
string
Type of change request (e.g., ‘normal’, ‘standard’, ‘emergency’).
string
Current phase of the change request workflow (e.g., ‘Planning’, ‘Assessment’, ‘Implementation’).
string
Impact level of the change request (typically 1-3, where 1 is highest).
string
Vendor associated with the change request.
string
Sys_id of the Configuration Item associated with the change.
string
Sys_id of the company associated with the change request.
string
Category classification of the change request (e.g., ‘Network’, ‘Hardware’, ‘Software’, ‘Communication’).
string
Comments visible to end users.
string
Contract reference or identifier associated with the change.
string
Sys_id of the location associated with the change request.
string
Priority level of the change request (typically 1-5, where 1 is highest).
string
Plan for testing the change after implementation.
string
Sys_id of the department associated with the change request.
string
Internal work notes (not visible to end users).
string
Sys_id of the user to assign the change request to.
string
Notes to be added when closing the change request.
string
Detailed description explaining what the change involves, its purpose, and expected outcomes.
string
Subcategory classification within the main category.
string
Plan for rolling back the change if issues occur.
string
Expected end date and time for the change (ISO 8601 format recommended).
string
Sys_id of the user who requested the change.
string
Business justification explaining why this change is needed.
string
Expected start date and time for the change (ISO 8601 format recommended).
string
Reason for placing the change request on hold.
string
Sys_id of the group to assign the change request to.
string
Planned end date and time for the change (format: YYYY-MM-DD HH:MM:SS or ISO 8601).
string
Sys_id of the service offering related to the change.
string
Date by which the change is requested (format: YYYY-MM-DD HH:MM:SS or ISO 8601).
string
Brief summary or title of the change request (recommended, displayed in lists).
string
Planned start date and time for the change (format: YYYY-MM-DD HH:MM:SS or ISO 8601).
string
Detailed plan for implementing the change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CHG_REST_CHANGE_CICreates an association between a change request and one or more configuration items (CIs) in ServiceNow. Use this action when you need to link CIs (servers, databases, applications, etc.) to a change request in ServiceNow’s Change Management module. This is commonly used to: - Define which infrastructure components are affected by a change - Include specific CIs in the scope of a change request - Track and manage CI relationships for change planning The action requires the change request sys_id and a list of CI sys_ids to associate.

Input Parameters

string
required
The unique system ID (sys_id) of the change request. This is a 32-character hexadecimal string that uniquely identifies the change request record. Example: ‘46e9b4afa9fe198101026e122b85f442’
array
required
List of sys_ids of the Configuration Items (CIs) to associate with the change request. Each sys_id is a 32-character hexadecimal string that uniquely identifies a CI record in the CMDB. Example: [‘00a96c0d3790200044e0bfc8bcbe5db4’]
string ("affected" | "requested" | "requested_and_affected")
Type of CI association with the change request. ‘affected’: The CI is affected by the change request. ‘requested’: The CI is requested to be included in the change request. ‘requested_and_affected’: The CI is both requested and affected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CHG_REST_CHANGE_CONFLICTStarts the conflict checking process for a ServiceNow change request, identifying scheduling conflicts with other changes or blackout windows. Use this action when you need to initiate a conflict check for a change request. This is typically used to verify that a change request doesn’t conflict with other scheduled changes or fall within a blackout window. This is commonly used before approving or implementing a change to ensure proper scheduling and avoid resource conflicts. Note: This action starts the conflict check process asynchronously. Use the GetChangeConflict action to retrieve the results of the conflict check once it completes.

Input Parameters

string
required
The unique system ID (sys_id) of the change request to start conflict checking for. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘46e9b4afa9fe198101026e122b85f442’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CHG_REST_CHANGE_EMERGENCYCreates an emergency change request in ServiceNow using the Change Management API. Use this action when you need to create an expedited change request that requires urgent approval and implementation due to critical business requirements or emergency situations. Emergency changes bypass standard approval workflows to enable rapid response to urgent needs. This action creates a new emergency change request record and returns the generated sys_id and change request number for future reference.

Input Parameters

string
Reason for the emergency change request explaining the urgency
string
Sys_id of the affected Configuration Item (CI) in CMDB
string
Full description of the emergency change request providing detailed context
string
required
Short description of the emergency change request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CHG_REST_CHANGE_NORMALCreates a normal change request in ServiceNow using the Change Management REST API. Use when you need to create a standard change request that follows the normal approval workflow. Normal changes are subject to standard CAB (Change Advisory Board) review and approval processes before implementation. This action is appropriate for planned changes that can follow the normal change lifecycle. This action creates a new normal change request record and returns the generated sys_id and change request number for future reference and tracking.

Input Parameters

string
Sys_id of the affected Configuration Item (CI) in CMDB
string
Full description of the normal change request providing detailed context
string
Sys_id of the assignment group responsible for implementing the change
string
required
Short description of the normal change request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CHG_REST_CHANGE_STANDARDCreates a new standard change request in ServiceNow using a pre-approved standard change template. Use this action when you need to create a standard change request based on a predefined template from the std_change_record_producer table. Standard changes follow a pre-approved workflow and are typically lower-risk changes that follow standardized procedures defined by the organization. The template_id parameter should be the sys_id of an active standard change template. This action creates a new change request record populated with the fields defined in the template.

Input Parameters

string
required
The sys_id of the standard change template to use for creating the change request. This is a 32-character hexadecimal string that uniquely identifies the template in the std_change_record_producer table. Example: ‘1234567890abcdef1234567890abcdef’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CHG_REST_CHANGE_TASKCreates a new task for a ServiceNow change request using the Change Management REST API. Use this action when you need to add a new task or subtask to an existing change request, such as breaking down a change into smaller work items, assigning specific work to team members, or tracking additional work needed as part of the change process. The task will be automatically linked to the specified change request. After creation, use the returned sys_id to update or retrieve the task as needed.

Input Parameters

string
Initial state of the task. Common values: -5=Cancelled, -4=On hold, -3=Rejected, -2=Pending, -1=Draft, 1=Open, 2=Work In Progress, 3=Pending, 4=Complete. If not specified, defaults to the task type’s default state.
string
Category or type of the task
string
Public comments on the task (visible to end users)
string
Priority level of the task (e.g., ‘1’ for critical, ‘2’ for high, ‘3’ for moderate, ‘4’ for low, ‘5’ for planning)
string
Internal work notes for the task (visible to IT staff only)
string
sys_id of the user assigned to the task
string
Full description of the task
string
Expected end date and time of the task (ISO 8601 format)
string
required
The unique system ID (sys_id) of the change request to create a task for. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘46e9b4afa9fe198101026e122b85f442’. The change request must exist, or a 404 error will be returned.
string
Expected start date and time of the task (ISO 8601 format)
string
Reason the task is on hold (use with state=-4)
string
sys_id of the group assigned to the task
string
required
Brief summary or title of the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CICD_APP_BATCH_INSTALLInstalls two or more ServiceNow application packages in a single batch operation via the CICD API. Use this action when you need to deploy multiple applications at once as part of a CI/CD pipeline or automated deployment process. The batch install allows for efficient bulk installation of related applications rather than installing them one at a time. This action is idempotent — running it multiple times with the same packages will produce the same result. Note: At least two packages must be specified for a batch install operation.

Input Parameters

string
required
The name or label for this batch install operation. This is used for identification purposes.
array
required
List of packages to install in a single batch operation. Each package must have a ‘name’ field containing the application ID. At least two packages are required for batch installation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CICD_APP_REPO_INSTALLInstalls the specified application from the ServiceNow app repository. Use this action when you need to install an application from the ServiceNow Store or a private app repository onto your ServiceNow instance. This is commonly used during CI/CD pipelines to automate the deployment of applications. The action requires the sys_id of the application to install, which can be obtained from the app repository records or from a previous application listing operation.

Input Parameters

string
required
The sys_id of the application to install from the app repository. This is the unique system identifier for the application record in ServiceNow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CICD_INSTANCE_SCAN_FULL_SCANInitiates a full instance scan by running all active checks present in the ServiceNow instance. Use this action when you need to execute a comprehensive validation scan of your ServiceNow instance, running all configured active checks to identify configuration issues, best practice violations, or compliance problems. This is typically used during CI/CD pipelines or before major changes to ensure the instance meets required standards. This action starts an asynchronous scan operation - the response indicates the scan has been initiated with a ‘running’ state. Use the returned sys_id to track progress or retrieve detailed results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CICD_INSTANCE_SCAN_SUITE_SCAN_COMBORuns a CI/CD scan using a suite and target (scoped app) combination in ServiceNow. Use this action when you need to execute a compliance or best practices scan against a scoped application using a predefined scan suite and target combination. This is commonly used in CI/CD pipelines to validate that an application meets ServiceNow best practices before deployment or release. The combo_sys_id refers to a saved configuration that links a scan suite with a target scoped application. You can optionally override the target by providing target_scope_app_sys_id. This action modifies the ServiceNow instance by executing a scan. If async_execution is false (default), the request will wait for the scan to complete. Set async_execution to true if you want the scan to run in the background and return immediately.

Input Parameters

string
required
The unique system ID (sys_id) of the scan suite and target combination to run. This is a 32-character hexadecimal string that identifies the combo configuration containing the suite and target (scoped app) to scan. Example: ‘a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4’
boolean
When set to true, the scan runs asynchronously and returns immediately with a job ID. When false (default), the request waits for the scan to complete before returning.
string
The sys_id of the scoped application to run the scan against. If not provided, the target defined in the combo configuration will be used. Example: ‘f6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CICD_PLUGIN_ACTIVATEActivates the specified plugin in ServiceNow’s CICD Plugin API. Use this action when you need to activate a plugin on a ServiceNow instance as part of a CI/CD pipeline or automated deployment process. This is commonly used after deploying a plugin to enable its functionality on the target instance. This action modifies the state of the ServiceNow instance by activating the plugin. Ensure the plugin is compatible with your instance and that any prerequisites are met before activation.

Input Parameters

string
required
The unique identifier or name of the plugin to activate. This is typically the plugin’s scope name or full identifier (e.g., ‘com.glide.cs’, ‘com.snc.pdap’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_CICD_TESTSUITE_RUNStarts an automated test suite using ServiceNow’s CI/CD Pipeline API, identified by sys_id or name. The response may contain a progress identifier for monitoring; a failed operation can also be returned in the result.

Input Parameters

string
Deprecated alias for test_suite_sys_id, kept for backward compatibility. Use test_suite_sys_id instead.
string
The name of the automated test suite to run. Required if test_suite_sys_id is not specified.
string
The sys_id of the automated test suite (Test [sys_atf_test_suite]) to run. Required if test_suite_name is not specified. Example: ‘a1b2c3d4e5f67890abcdef1234567890’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_IND_TSM_SDWAN_TROUBLETICKETCreates a record using the ServiceNow Table API for a selected ticket type. Case, incident, problem, and change request map to their respective tables; other ticket type values are used as table names.

Input Parameters

string
Category or classification of the trouble ticket. Example categories: ‘Network’, ‘Hardware’, ‘Software’, ‘Security’. The exact categories depend on your ServiceNow configuration.
string
Priority level of the trouble ticket. Typical values: 1 = Critical (service down), 2 = High (major impact), 3 = Medium (moderate impact), 4 = Low (minor impact). The exact priority values depend on your ServiceNow configuration.
string
Sys_id of the user who reported or initiated the trouble ticket. This is the 32-character hexadecimal string that identifies the user. Example: ‘usr123abc456def789ghi012jkl345’
string
Internal work notes about the trouble ticket. These notes are only visible to users with appropriate roles and are not visible to end users or customers. Use this for technical details and updates. Example: ‘Investigated the issue and identified root cause as faulty switch’
string
Sys_id of the user assigned to handle the trouble ticket. This is the 32-character hexadecimal string that identifies the user. Example: ‘usr789xyz012abc345def678ghi901’
string
Full detailed description of the trouble ticket, including symptoms, impact, and any relevant background information. Example: ‘Users unable to access the corporate network since 9 AM’
string
Subcategory of the trouble ticket for more specific classification. Example subcategories: ‘Firewall’, ‘Router’, ‘Switch’, ‘VPN’. The exact subcategories depend on your ServiceNow configuration.
string
required
The type of trouble ticket to create. Common values include ‘case’, ‘incident’, or other ticket types supported by your ServiceNow Service Operations Workspace SD-WAN configuration. Example: ‘case’
string
Comma-separated list of fields to return in the response. Invalid fields are ignored. If not specified, all fields are returned. Example: ‘number,short_description,state,assigned_to’
string
Sys_id of the group assigned to handle the trouble ticket. This is the 32-character hexadecimal string that identifies the group. Example: ‘grp456def789ghi012jkl345mno678’
string
Brief summary or title of the trouble ticket. This describes the issue or request in a concise manner. Example: ‘Network connectivity issue in DC1’
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
boolean
Set to true if providing display values (e.g., user names) instead of sys_ids in record_data for reference fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response. Use this to reduce response size when reference links are not needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_SN_TMF_SERVICE_CATEGORYCreates a service catalog category in the ServiceNow sc_category table, with an optional parent category and description. The response is transformed into a category result.

Input Parameters

string
required
Name of the service category. This is a required field and should be a descriptive label for the category (e.g., ‘Hardware Services’, ‘Software Requests’). Category names should be unique within the same parent scope.
boolean
Indicates whether this category is a root-level (top-level) category. Set to true to create a top-level category with no parent. Set to false (or omit) to create a subcategory under an existing parent. When true, parent_id should not be provided.
string
The unique identifier of the parent service category. Required when creating a subcategory (is_root=false or omitted). Should be omitted or left empty when is_root=true. The parent category must exist, or the API will return an error.
string
Detailed description of the service category explaining its purpose, scope, and what types of items it contains. Use this to provide additional context for users browsing the service catalog.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_TABLEInserts a new record into a specified ServiceNow table using the Table API and returns the selected record fields. Response field selection can restrict which identifiers are returned.

Input Parameters

string
required
The name of the table where the record will be created (e.g., ‘incident’, ‘problem’, ‘change_request’, ‘sys_user’).
object
Field-value pairs for the new record. Available fields depend on the table schema. For ‘incident’ table, common fields include: ‘short_description’, ‘description’, ‘urgency’ (1-3), ‘impact’ (1-3), ‘priority’, ‘assignment_group’, ‘assigned_to’, ‘category’, ‘state’. For reference fields (like ‘assignment_group’ or ‘assigned_to’), use the sys_id of the referenced record, or set sysparm_input_display_value=true to use display values. Example: {‘short_description’: ‘Network outage’, ‘urgency’: ‘1’, ‘impact’: ‘1’, ‘description’: ‘Unable to access network’}
string ("desktop" | "mobile" | "both")
UI view to determine which fields are returned in the response. If not specified, returns fields from the default view.
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state’). Invalid fields are ignored. If not specified, all fields are returned.
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
boolean
Set to true if providing display values (e.g., user names) instead of sys_ids in record_data for reference fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_TABLE_INCIDENTCreates a new ServiceNow incident using the Table API, with a required short description and optional incident and assignment fields. The response can be restricted to selected fields.

Input Parameters

string ("1" | "2" | "3" | "6" | "7" | "8")
Incident state values
string ("1" | "2" | "3" | "4")
Impact levels for incident records
string
Sys_id of the Configuration Item (CI) affected by this incident.
string
Sys_id of the company associated with this incident.
string ("1" | "2" | "3" | "4")
Urgency levels for incident records
string
Category of the incident (e.g., ‘Inquiry’, ‘Problem’, ‘Software’, ‘Hardware’, ‘Network’).
string
Additional comments or notes about the incident that are visible to end users.
string
Sys_id of the location where the incident occurred.
string ("1" | "2" | "3" | "4" | "5")
Priority levels for incident records
string
Sys_id of the user who reported the incident. If not provided, the current user is used as the caller.
string
Comma-separated list of user sys_ids who should receive notifications about this incident.
string
Internal work notes visible only to support staff, not to end users.
string
Sys_id of the user assigned to work on the incident.
string
Detailed description of the incident including steps to reproduce, error messages, and any relevant context.
string
Subcategory of the incident within the selected category.
string
Method by which the incident was reported (e.g., ‘Phone’, ‘Email’, ‘Self-service’, ‘Walk-in’).
string
Comma-separated list of fields to return in the response (e.g., ‘number,sys_id,state’). Invalid fields are ignored.
string
Sys_id of the group to which the incident is assigned.
string
Sys_id of the business service affected by this incident.
string
required
Brief summary of the incident. This field is required and should clearly describe the issue.
string
Determines the format of field values in the response. ‘false’ returns actual values (default), ‘true’ returns display values, ‘all’ returns both.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_CREATE_UPDATE_CMD_CICreates or updates CMDB configuration items (CIs) using the ServiceNow Identification and Reconciliation Engine (IRE) via the identify-reconcile endpoint. Use this action when you need to upsert CIs into the CMDB with automatic deduplication. The IRE matches incoming CI data against existing records using configured identification rules (based on fields like name, IP address, serial number, etc.) and either updates the matched CI or creates a new one. This prevents duplicate configuration items from being created. You can also submit relationship data alongside CIs to create or update CI relationships (e.g., ‘Contains’, ‘Depends on’). Note: Identification rules must be configured in ServiceNow for this endpoint to work correctly. If no matching rule is found, the IRE may create a new CI or reject the entry depending on your configuration.

Input Parameters

array
required
Array of CI objects to insert or update in the CMDB using the Identification and Reconciliation Engine (IRE). Each object contains CMDB fields that are used both for matching (via identification rules) and for populating CI attributes. Key fields include: ‘className’ (CMDB table name), ‘name’ (CI display name), ‘sys_id’ (to update an existing CI directly), ‘ip_address’, ‘serial_number’, ‘host_name’, ‘mac_address’, ‘fqdn’, ‘manufacturer’, ‘model_id’, etc. The IRE matches incoming CIs against existing records using identification rules configured in ServiceNow, preventing duplicate CIs. Example: [{‘className’: ‘cmdb_ci’, ‘name’: ‘test-ci’, ‘ip_address’: ‘192.168.1.100’}]
array
Array of relationship objects to create or update alongside the CIs. Each relation links a parent CI to a child CI with a relationship type. Fields include: ‘parent’ (sys_id or name of parent CI), ‘child’ (sys_id or name of child CI), ‘type’ (relationship type name). Example: [{‘parent’: ‘web-server-01’, ‘child’: ‘web-app-01’, ‘type’: ‘Contains’}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_A_RECORDPermanently deletes a specific record from a ServiceNow table using its sys_id. This is a destructive operation that cannot be undone. The record will be permanently removed from the table. Requires the user to have delete permissions on the specified table. If the record doesn’t exist or the user lacks permissions, an error will be returned. Common use cases: Removing test data, cleaning up duplicate records, deleting obsolete incidents/problems/tasks.

Input Parameters

string
required
The unique system ID (sys_id) of the record to delete. This is a 32-character hexadecimal string that uniquely identifies the record. Example: ‘8866498dc37a3610eb10d8477d013161’. The record must exist in the specified table, or a 404 error will be returned.
string
required
Name of the ServiceNow table from which to delete the record (e.g., ‘incident’, ‘problem’, ‘change_request’, ‘task’). The table must exist in the ServiceNow instance and the user must have delete permissions for it.
boolean
Set to true to include records from domains the logged-in user is not configured to access (requires admin or query_no_domain_table_api role). When false (default), only records in the user’s configured domains can be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_ATTACHMENT_BY_IDPermanently deletes a specific attachment from ServiceNow using its sys_id. This is a destructive, irreversible operation — the attachment cannot be recovered once deleted. Requires the user to have delete permissions on the attachment. If the attachment doesn’t exist or the user lacks permissions, an error will be returned. This action should be used when you have the specific sys_id of an attachment to remove (obtained from FindFile action). Use when you need to remove a specific file attachment from a record and know its sys_id.

Input Parameters

string
required
The unique system ID (sys_id) of the attachment to delete. This is a 32-character hexadecimal string that uniquely identifies the attachment record in ServiceNow. Example: ‘003a3ef24ff1120031577d2ca310c74b’. The attachment must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_ATTACHMENT_BY_ID_V1Permanently deletes a specific attachment from ServiceNow using its sys_id via the v1 API endpoint. This is a destructive, irreversible operation — the attachment cannot be recovered once deleted. Requires the user to have delete permissions on the attachment record. If the attachment does not exist or the user lacks permissions, an error will be returned. This action uses the /api/now/v1/attachment/{sys_id} endpoint specifically. Use when you need to remove a specific file attachment from a record and already know its sys_id.

Input Parameters

string
required
The unique system ID (sys_id) of the attachment to delete. This is a 32-character hexadecimal string that uniquely identifies the attachment record in ServiceNow. Example: ‘00e7525ddf710100a9e78b6c3df2639c’. The attachment must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_ATTACHMENT_CSMDeletes a ServiceNow attachment by its sys_id, including attachments associated with CSM records. This is a destructive operation and requires appropriate permissions.

Input Parameters

string
required
The unique system ID (sys_id) of the CSM attachment to delete. This is a 32-character hexadecimal string that uniquely identifies the attachment record in ServiceNow. Example: ‘260380fa833bf210dd2dc2dfeeaad3c1’. The attachment must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_CHANGE_TASKPermanently deletes a specific task from a ServiceNow change request using its sys_id. This is a destructive, irreversible operation. The task will be permanently removed from the change request and cannot be recovered once deleted. Use this action with caution. Requires the user to have appropriate permissions to delete tasks from change requests. If the change request or task doesn’t exist, or if the user lacks permissions, an error will be returned. Use this action when you need to clean up obsolete or incorrect tasks from change requests.

Input Parameters

string
required
The unique system ID (sys_id) of the task to delete from the change request. This is a 32-character hexadecimal string that uniquely identifies the task. Example: ‘d262847a833bf210dd2dc2dfeeaad353’. The task must exist within the specified change request, or a 404 error will be returned.
string
required
The unique system ID (sys_id) of the change request that contains the task. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘46e9b4afa9fe198101026e122b85f442’. The change request must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_CI_LIFECYCLE_MGMT_ACTIONPermanently deletes a specific CI Lifecycle Management action from ServiceNow using its sys_id. Use this action when you need to remove a CI Lifecycle Management action record that is no longer needed. This action is irreversible — the CI action cannot be recovered once deleted. Requires the user to have appropriate permissions for the CI Lifecycle Management module. Use when you need to clean up obsolete, incorrect, or duplicate CI lifecycle action records.

Input Parameters

string
required
The unique system ID (sys_id) of the CI Lifecycle Management action to delete. This is a 32-character hexadecimal string that uniquely identifies the action record. Example: ‘9a8f5b3c1d4e7f2a6b0c8d3e5f7a1b9c’. The action must exist, or a 404 error will be returned. This parameter corresponds to the ‘sys_id’ field of the ‘statemgmt_ci_actions’ table.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_CI_LIFECYCLE_MGMT_OPERATORSPermanently unregisters an operator from the ServiceNow CI Lifecycle Management system. This action removes an operator registration for non-workflow users. This is a destructive, irreversible operation — once the operator is unregistered, it cannot be recovered and will need to be re-registered if needed again. Use this action with caution. Use when you need to clean up obsolete operator registrations for non-workflow users in the CI Lifecycle Management system. The user must have appropriate permissions to unregister operators. If the operator doesn’t exist or the user lacks permissions, an error will be returned.

Input Parameters

string
required
The unique identifier of the operator to unregister. This is the operator ID that was assigned when the operator was registered. Example: ‘test-operator-id-123’. The operator must exist in the CI Lifecycle Management system, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_CMDB_INSTANCE_RELATIONPermanently deletes a specific CMDB CI (Configuration Item) relation using its sys_id. This is a destructive, irreversible operation — the relation between two CIs cannot be recovered once deleted. The relation represents a connection between a parent and child CI (e.g., a server running an application). Requires the user to have the ITIL role and appropriate CMDB permissions. If the relation, CI, or class doesn’t exist, or the user lacks permissions, an error will be returned. Use when you need to remove a specific relationship between two configuration items in the CMDB.

Input Parameters

string
required
The sys_id of the CI (Configuration Item) record. This is a required path parameter that uniquely identifies the CI instance within the specified class table. It is a 32-character hexadecimal string. Example: ‘106c5c13c61122750194a1e96cfde951’
string
required
Name of the CMDB CI (Configuration Item) class. This is a required path parameter that identifies the class table to which the CI belongs. Common values include ‘cmdb_ci_server’, ‘cmdb_ci_application’, ‘cmdb_ci_service_discovered’, etc. Example: ‘cmdb_ci_server’
string
required
The sys_id of the CMDB relation to delete. This is a required path parameter that uniquely identifies the relationship record between two CIs. It is a 32-character hexadecimal string. Example: ‘2ce248ba833bf210dd2dc2dfeeaad3c0’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_EMERGENCY_CHANGE_REQUESTPermanently deletes a specific emergency change request from ServiceNow using its sys_id. This is a destructive operation that cannot be undone. The emergency change request will be permanently removed from the system. Use this action when an emergency change request is no longer needed or was created in error. Use this action when you need to remove an emergency change request from ServiceNow. This action is irreversible — the emergency change request cannot be recovered once deleted. Requires the user to have delete permissions for change requests. If the record doesn’t exist, is not an emergency change request, or the user lacks permissions, an error will be returned.

Input Parameters

string
required
The unique system ID (sys_id) of the emergency change request to delete. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘45b188f6833bf210dd2dc2dfeeaad324’. The record must exist and be an emergency change request, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_INCIDENT_BY_IDPermanently deletes a specific incident from ServiceNow using its sys_id. This is a destructive, irreversible operation — the incident cannot be recovered once deleted. Requires the user to have delete permissions for the incident table. If the incident doesn’t exist or the user lacks permissions, an error will be returned. Use this action when you need to remove a specific incident record and know its sys_id.

Input Parameters

string
required
The unique system ID (sys_id) of the incident to delete. This is a 32-character hexadecimal string that uniquely identifies the incident record. Example: ‘46b66a40a9fe198101f243dfbc79033d’. The incident must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_INCIDENT_BY_ID2Permanently deletes a specific incident from ServiceNow using its sys_id via the Table API. This is a destructive, irreversible operation — the incident cannot be recovered once deleted. Requires the user to have delete permissions for the incident table. If the incident doesn’t exist or the user lacks permissions, an error will be returned. Use when you need to remove a specific incident record and know its sys_id.

Input Parameters

string
required
The unique system ID (sys_id) of the incident to delete. This is a 32-character hexadecimal string that uniquely identifies the incident record. Example: ‘46b66a40a9fe198101f243dfbc79033d’. The incident must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_SERVICECATALOG_CARTRemoves a specific item from the current ServiceNow Service Portal shopping cart. This action permanently removes a cart item from the active shopping cart session. Use this action when a user wants to remove an unwanted item from their Service Catalog cart before submitting the order. This action is irreversible — once the item is removed, it must be added again if still needed. Use when you need to remove an item from a user’s Service Portal shopping cart and have the cart item’s sys_id.

Input Parameters

string
required
The unique system ID (sys_id) of the cart item to remove from the current shopping cart. This is a 32-character hexadecimal string that uniquely identifies the cart item. Example: ‘b2754c3283fbf210dd2dc2dfeeaad33b’. The cart item must exist in the current user’s cart, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_SERVICE_CATALOG_CART_EMPTYEmpties all items from a specified Service Catalog shopping cart using its sys_id. This action removes all items from the cart but does not delete the cart itself. This is a destructive, irreversible operation — all cart items will be permanently removed and cannot be recovered once emptied. Use this action with caution. Use when you need to clear all items from a user’s Service Catalog shopping cart before adding new items or before discarding an unwanted order.

Input Parameters

string
required
The unique system ID (sys_id) of the Service Catalog shopping cart to empty. This is a 32-character hexadecimal string that uniquely identifies the cart record. Example: ‘8df4cc7a83bbf210dd2dc2dfeeaad380’. All items within the cart will be permanently removed, but the cart itself will remain. The cart must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_SN_CHG_REST_CHANGEPermanently deletes a specific change request using its sys_id via the Change Management REST API. Use this action when you need to remove a change request from ServiceNow that is no longer needed. This action is irreversible — the change request cannot be recovered once deleted. Requires the user to have appropriate permissions for the change management module.

Input Parameters

string
required
The unique system ID (sys_id) of the change request to delete. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘1766f1de47410200e90d87e8dee490f6’. The change request must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_SN_CHG_REST_CHANGE_NORMALPermanently deletes a normal change request identified by its sys_id using the ServiceNow Change Management REST API. This is a destructive operation that cannot be undone. The normal change request will be permanently removed from the system. Use when you need to remove an unwanted or obsolete normal change request from ServiceNow. This action is irreversible — the change request cannot be recovered once deleted.

Input Parameters

string
required
The unique system ID (sys_id) of the normal change request to delete. This is a 32-character hexadecimal string that uniquely identifies the change request record. Example: ‘2071a5d037310200f212cc028e41f107’. The change request must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_SN_CHG_REST_CHANGE_STANDARDPermanently deletes a standard change request from ServiceNow using its sys_id. Use this action when you need to remove a specific standard change request that is no longer needed. This is a destructive operation that cannot be undone — the standard change request cannot be recovered once deleted. Requires appropriate permissions to delete change requests in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the standard change request to delete. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘2de5121347c12200e0ef563dbb9a71eb’. The change request must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_TABLEPermanently deletes a specific record from a ServiceNow table using its sys_id. Use this action when you need to remove a record from a ServiceNow table and the record’s sys_id is known. This is a destructive operation that cannot be undone. The record will be permanently removed from the table. Requires the user to have delete permissions on the specified table. If the record doesn’t exist or the user lacks permissions, an error will be returned.

Input Parameters

string
required
The unique system ID (sys_id) of the record to delete. This is a 32-character hexadecimal string that uniquely identifies the record. Example: ‘3a24ff2e83b7f210dd2dc2dfeeaad37e’. The record must exist in the specified table, or a 404 error will be returned.
string
required
Name of the ServiceNow table from which to delete the record (e.g., ‘incident’, ‘problem’, ‘change_request’, ‘task’). The table must exist in the ServiceNow instance and the user must have delete permissions for it.
boolean
Set to true to include records from domains the logged-in user is not configured to access (requires admin or query_no_domain_table_api role). When false (default), only records in the user’s configured domains can be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_DELETE_TABLE_INCIDENTPermanently deletes a specific incident record from ServiceNow using its sys_id. This is a destructive, irreversible operation — the incident cannot be recovered once deleted. Requires the user to have delete permissions on the incident table. If the incident doesn’t exist or the user lacks permissions, an error will be returned. Use when you need to remove a specific incident record from ServiceNow and know its sys_id.

Input Parameters

string
required
The unique system ID (sys_id) of the incident record to delete. This is a 32-character hexadecimal string that uniquely identifies the incident. Example: ‘1c741bd70b2322007518478d83673af3’. The incident must exist, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_FIND_FILERetrieves attachment metadata from ServiceNow’s sys_attachment table. This endpoint queries file attachments and returns metadata including file name, size, content type, download links, and associated table information. Use sysparm_query to filter by file name, table name, content type, or other attachment properties. Note: This returns metadata only; use the download_link in the response to retrieve actual file content.

Input Parameters

string
Limit to be applied on pagination. Note: Unusually large sysparm_limit values can impact system performance.
string
Encoded query. Queries for the Attachment API are relative to the Attachments [sys_attachment] table. For example: (sysparm_query=file_name=attachment.doc) The encoded query provides support for order by. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query. For example, sysparm_query=ORDERBYfile_name^ORDERBYDESCtable_Name orders the results in ascending order by name first, then in descending order by table name.
string
Number of records to exclude from the query. Use this parameter to get more records than specified in sysparm_limit parameter. For example, if sysparm_limit is set to 500, but there are additional records you want to query, you can specify a sysparm_offset parameter value of 500 to get the second set of records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_ACTSUB_ACTIVITIESRetrieves activity records from the ServiceNow ActivitySubscription API. Requests can specify a stream and paginate using limit and offset; the default limit is 25.

Input Parameters

string
The type of activity stream to retrieve. Default value is ‘activities’ which returns all activity records. Other values may include specific activity types supported by the subscription API.
integer
Maximum number of activity records to return. Use pagination parameters to retrieve additional records if the limit is exceeded.
integer
Starting record index for which to begin retrieving activities. Use this value to paginate through activity records by incrementing by the limit value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_ACTSUB_FACETSRetrieves activity subscription facets for a specified ServiceNow activity context and context instance. An HTTP 400 response is returned as a result with no facets.

Input Parameters

string
required
The type of activity context for which to retrieve facets. Common values include ‘table’ for table-level subscriptions, ‘record’ for specific record subscriptions, or other activity context types defined in the ServiceNow instance.
string
required
The specific instance identifier for the activity context. For ‘table’ context, this would be the table name (e.g., ‘incident’, ‘task’). For ‘record’ context, this would be the sys_id of the specific record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_AGENT_INTELLIGENCE_SOLUTION_PREDICTIONRequests a prediction from a named ServiceNow Agent Intelligence solution, optionally supplying input field values. The response may include a predicted value and confidence score.

Input Parameters

object
A dictionary of input field names and their values to pass to the prediction model. The required fields depend on the solution’s trained model — typically these are the input features the model was trained on (e.g., for an incident predictor: {‘urgency’: ‘high’, ‘impact’: ‘medium’, ‘category’: ‘software’}). Leave empty or omit if the solution does not require input field values. Values can be strings, integers, floats, or booleans.
string
required
The name of the Agent Intelligence solution to use for prediction. This is a required path parameter identifying the trained predictive model. Example: ‘incident_assignment_predictor’ or ‘task_priority_model’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_AGENT_INTELLIGENCE_SOLUTION_PREDICTION_LISTRetrieves a list of solution predictions from ServiceNow’s Agent Intelligence engine. Use this action when you need to fetch predicted solutions for multiple records, such as retrieving AI-recommended solutions for incidents, problems, or change requests. The predictions include confidence scores, solution details, and relevance metrics to help resolve issues more efficiently. Supports filtering, pagination, and confidence thresholds. This action is useful for implementing AI-powered resolution suggestions, analyzing prediction patterns, or integrating Agent Intelligence insights into custom workflows.

Input Parameters

integer
Maximum number of solution predictions to return. Use pagination parameters to retrieve additional results if needed. Note: Large values may impact system performance.
string
Encoded query to filter solution predictions. Syntax: <col_name><operator><value>. Supports operators: = (exact match), != (not equal), ^ (AND), ^OR (OR), LIKE (contains string), STARTSWITH, ENDSWITH. Example: category=password^confidence_score>=0.8
integer
Starting record index for pagination. Use sysparm_offset + sysparm_limit to page through results. For example, first call with offset=0, next call with offset=sysparm_limit.
string
Type of predictions to retrieve. Common values: ‘incident’, ‘problem’, ‘change’, ‘task’. If not specified, returns all prediction types.
boolean
Flag to include additional metadata in the response. Set to true to include extended prediction metadata.
number
Minimum confidence score threshold for returned predictions. Only predictions with confidence_score >= this value will be returned. Example: 0.8 returns only high-confidence predictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_ALL_DATA_CLASSESRetrieves data classification records from the ServiceNow data_classification table. Use limit and offset to paginate through the records.

Input Parameters

integer
Maximum number of records to return. Use with sysparm_offset to paginate through results.
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to retrieve the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_APP_SERVICE_CONTENTRetrieves configuration items associated with an application service in ServiceNow CMDB, identified by its sys_id. Use it to explore service components for impact analysis or change management; the request supports field selection, display options, and limit/offset pagination.

Input Parameters

string
required
The sys_id (unique identifier) of the application service whose configuration items (CIs) you want to retrieve.
integer
Maximum number of configuration items to return. Use pagination parameters for larger result sets.
string
Comma-separated list of fields to return. Invalid field names are silently ignored. Example: ‘sys_id,name,ip_address’
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to paginate through results.
string
Determines the format of field values in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_ATTACHMENT_BY_IDRetrieves metadata for a specific attachment by its sys_id from ServiceNow. Use this action when you need to fetch information about a single attachment file, such as its file name, content type, size, and associated record details. This action returns metadata only; to download the actual file content, use the download_link from the FindFile action or access the file directly via the ServiceNow attachment API.

Input Parameters

string
required
The sys_id of the attachment to retrieve. This is the unique identifier assigned to the attachment when it was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_ATTACHMENT_BY_ID_V1Retrieves metadata for a specific attachment by its sys_id from ServiceNow. Use this action when you need to fetch detailed information about a single attachment file, such as its file name, content type, size, download link, image dimensions (for images), and associated record details. This action returns metadata only; to download the actual file content, use the download_link provided in the response or the GetAttachmentFile action.

Input Parameters

string
required
The sys_id of the attachment to retrieve. This is the unique identifier assigned to the attachment when it was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_ATTACHMENT_FILEDownloads the binary file attachment with the specified sys_id from ServiceNow. Use this action when you need to retrieve the actual file content of an attachment that was previously uploaded to a ServiceNow record (e.g., incident, problem, change_request). This action returns the raw binary file data which can then be saved locally or processed further. The attachment sys_id can be obtained from the ‘FindFile’ action or from the ServiceNow UI.

Input Parameters

string
required
Sys_id of the attachment to download. This is the unique identifier of the attachment record in ServiceNow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_ATTACHMENT_FILE_FILEDownloads the binary file attachment with the specified sys_id from ServiceNow using the v1 API endpoint. Use this action when you need to retrieve the actual file content of an attachment that was previously uploaded to a ServiceNow record (e.g., incident, problem, change_request) via the /api/now/v1/attachment endpoint. This action returns the raw binary file data which can then be saved locally or processed further. The attachment sys_id can be obtained from the ‘GetAttachmentList’ or ‘GetAttachmentById’ actions.

Input Parameters

string
required
System ID of the attachment record from which to return binary data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_ATTACHMENT_LISTRetrieves metadata for multiple file attachments from ServiceNow’s Attachment API. Use this action to list and filter attachments across the instance, including filtering by table name, file name, content type, size, or other attachment properties. Supports pagination via sysparm_limit and sysparm_offset parameters. Note: This returns metadata only; actual file content must be downloaded separately using the sys_id.

Input Parameters

integer
Maximum number of attachment records to return. Use this parameter to limit the response size when querying multiple attachments. For requests that exceed this number, use sysparm_offset to paginate. Note: Unusually large sysparm_limit values can impact system performance.
string
Encoded query to filter attachments. Queries are relative to the sys_attachment table. Syntax follows ServiceNow encoded query format: <column><operator><value>. Operators: = (equals), != (not equals), ^ (AND), ^OR (OR), LIKE (contains), STARTSWITH, ENDSWITH. Examples: file_nameLIKEreport - attachments with ‘report’ in the file name; table_name=incident - attachments on incident records; content_type=image%2Fpng - PNG images; size_bytes>1000000 - files larger than 1MB. Use ORDERBY or ORDERBYDESC for sorting: ORDERBYfile_name, ORDERBYDESCsys_created_on.
integer
Starting record index for pagination. Use this to retrieve additional records beyond the sysparm_limit. For example, if sysparm_limit is 25, set sysparm_offset=25 to retrieve the next batch of records. Continue incrementing by sysparm_limit until you have retrieved all desired records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CHANGE_CI_SCHEDULERetrieves change scheduling information for a specific ServiceNow configuration item and requested duration. The response may include worker and schedule information.

Input Parameters

string
required
The sys_id of the Configuration Item (CI) in the CMDB for which to retrieve available change schedule time slots. This is a 32-character unique identifier for the CI record.
integer
required
The requested duration of the change window in seconds. The API returns only schedule slots that can accommodate a change of this duration. For example, 3600 seconds = 1 hour, 7200 seconds = 2 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CHANGE_CONFLICTRetrieves the conflict status for a ServiceNow change request, identifying scheduling conflicts with other changes or blackout windows. Use this action when you need to check if a change request has any scheduling conflicts with other changes or if it falls within a blackout window. This is typically used before approving or implementing a change to ensure proper scheduling and avoid resource conflicts.

Input Parameters

string
required
The unique system ID (sys_id) of the change request to retrieve conflict status for. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘46e9b4afa9fe198101026e122b85f442’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CHANGE_NEXTSTATESRetrieves a list of available next states for a specified change request based on the current state and workflow. Use this action when you need to determine what state transitions are valid for a particular change request, such as when deciding which state to move a change to or when validating workflow transitions.

Input Parameters

string
required
The sys_id of the change request for which to retrieve available next states.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CHANGE_REQUEST_CIRetrieves configuration items (CIs) associated with a specific change request in ServiceNow. Use this action when you need to fetch the list of configuration items (servers, databases, applications, etc.) that are linked to a change request. This is commonly used to: - Review affected infrastructure before approving a change - Understand the scope of impact for a change request - Verify that all required CIs are included in the change The association_type parameter determines which CIs to retrieve based on their relationship to the change request.

Input Parameters

string
required
The unique system ID (sys_id) of the change request. This is a 32-character hexadecimal string that uniquely identifies the change request record. Example: ‘46e9b4afa9fe198101026e122b85f442’
string ("affected" | "requested" | "requested_and_affected")
Type of CI association to retrieve for the change request. ‘affected’: Retrieves CIs that are affected by the change request. ‘requested’: Retrieves CIs that are requested to be included in the change request. ‘requested_and_affected’: Retrieves both requested and affected CIs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CHANGE_SCHEDULERetrieves scheduling information for a ServiceNow change request. The response may include schedule slots or an asynchronous worker response while schedule calculation is in progress.

Input Parameters

string
required
The unique system ID (sys_id) of the change request. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘46e9b4afa9fe198101026e122b85f442’. You can obtain this from the sys_id field of a change request record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CILIFECYCLEMGMT_ACTIONSRetrieves a specific CI Lifecycle Management action from ServiceNow using its sys_id. Use this action when you need to fetch detailed information about a particular CI Lifecycle Management action, including its name, state, description, and associated CMDB class. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the CI Lifecycle Management action to retrieve. This is a 32-character hexadecimal string that uniquely identifies the action record. Example: ‘00000000000000000000000000000000’
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,name,state,class_name’
string
Determines the type of data returned for reference fields. ‘false’: Returns actual database values (sys_ids for references). ‘true’: Returns display values (names for references). ‘all’: Returns both display and actual values.
Flag that indicates whether to exclude Table API links for reference fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CILIFECYCLEMGMT_COMPAT_ACTIONSDetermines whether two specified Configuration Items (CIs) in the ServiceNow CMDB are compatible using the CI Lifecycle Management compatActions endpoint. Use this action when you need to verify compatibility between two Configuration Items before planning changes, deployments, or scheduling activities that involve multiple CIs. This helps ensure that changes to one CI won’t negatively impact another CI in the configuration.

Input Parameters

string
required
The sys_id of the first Configuration Item (CI) to check for compatibility. This is a 32-character hexadecimal string that uniquely identifies the CI record in the CMDB. Example: ‘00a96c0d3790200044e0bfc8bcbe5db4’
string
required
The sys_id of the second Configuration Item (CI) to check for compatibility. This is a 32-character hexadecimal string that uniquely identifies the CI record in the CMDB. Example: ‘00a96c0d3790200044e0bfc8bcbe5db5’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CI_LIFECYCLE_MGMT_LEASES_EXPIREDDetermines whether a CI Lifecycle Management lease has expired for the specified lease record. Use this action when you need to check the expiration status of a lease in ServiceNow’s CI Lifecycle Management system. This is a read-only operation that queries whether the specified lease has expired based on its end date and current system time. This action is useful for: - Verifying lease validity before performing operations that require an active lease - Auditing expired leases in the CMDB - Triggering renewal workflows when leases are expired

Input Parameters

string
required
The unique system ID (sys_id) of the lease record to check for expiration status. This is a 32-character hexadecimal string that uniquely identifies the lease record in the CI Lifecycle Management system. Example: ‘00000000000000000000000000000001’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CI_LIFECYCLE_MGMT_NOT_ALLOWED_OPS_TRANSITIONChecks CI lifecycle transition restrictions for a specified ServiceNow configuration item.

Input Parameters

string
required
The unique system ID (sys_id) of the configuration item (CI) to check for not allowed operations transition. This is a 32-character hexadecimal string that uniquely identifies the CI record in ServiceNow CMDB. Example: ‘00a96c0d3790200044e0bfc8bcbe5db4’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CILIFECYCLEMGMT_REQUESTORS_VALIDValidates whether a specified active workflow requestor exists and is valid in ServiceNow CI Lifecycle Management. Use this action when you need to verify that a CI Lifecycle Management workflow requestor is valid and active before proceeding with related operations such as change requests, deployment approvals, or CI lifecycle workflows. This is a read-only check that does not modify any data. The action queries the CI Lifecycle Management API with the requestor ID and returns a boolean result indicating validity. If the requestor is not found or is inactive, the API typically returns false.

Input Parameters

string
required
The unique identifier of the workflow requestor to validate. This is typically the sys_id of the requestor record in the CI Lifecycle Management system. Example: ‘test123456789012345678901234567’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CI_LIFECYCLE_MGMT_STATUSESRetrieves the current operational status for a Configuration Item (CI) in ServiceNow CMDB using the CI Lifecycle Management API. Use this action when you need to check the current operational state of a specific Configuration Item, such as whether it is running, has a problem, or is non-operational. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the Configuration Item (CI) for which to retrieve the current operational status. This is a 32-character hexadecimal string that uniquely identifies the CI record in ServiceNow CMDB. Example: ‘00a96c0d3790200044e0bfc8bcbe5db4’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CMDB_CI_LINUX_SERVERRetrieves a single CMDB Linux server configuration item (CI) by its sys_id, including its attributes and relationship information. Use this action when you need to fetch detailed information about a specific Linux server from ServiceNow’s CMDB, such as its attributes (name, IP address, OS version, kernel version, etc.) and both its inbound (dependents) and outbound (dependencies) relationships with other CIs. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the CMDB Linux server configuration item to retrieve. This is a 32-character hexadecimal string that uniquely identifies the CI record. Example: ‘3a290cc60a0a0bb400000bdb386af1cf’
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,name,ip_address,operational_status’
string
Determines the format of field values in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CMDB_CSDM_APP_SERVICE_FIND_SERVICEFinds and returns basic information about one or more application services in the ServiceNow CMDB using the CSDM (Common Service Data Model) app_service find_service endpoint. Use this action when you need to search for application services by name (supports wildcards), retrieve their basic metadata such as operational status, owning segment, and business criticality, or check whether a specific application service exists in the CMDB.

Input Parameters

string
required
Name of the application service to find. Supports wildcards using '' prefix or suffix. Examples: ‘My Service’, ‘-production’, ‘app-’, ‘-db-*’
integer
Maximum number of application service records to return. Use pagination parameters for larger result sets.
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,name,description,operational_status’
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to paginate through results.
string
Determines the format of field values in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CMDB_INSTANCERetrieves configuration items (CIs) from a specified CMDB class using the ServiceNow CMDB Instance API. Use this action when you need to query configuration items from the CMDB by class name, such as retrieving all servers (cmdb_ci_server), computers (cmdb_ci_computer), databases (cmdb_ci_database), or all CIs (cmdb_ci). Supports filtering via sysparm_query and pagination via sysparm_limit and sysparm_offset.

Input Parameters

string
required
Name of the CMDB class to query (e.g., ‘cmdb_ci’, ‘cmdb_ci_server’, ‘cmdb_ci_computer’, ‘cmdb_ci_database’, ‘cmdb_ci_service_discovered’, ‘cmdb_ci_application’). Use ‘cmdb_ci’ to query the base CI class and retrieve all configuration items.
integer
Maximum number of configuration item records to return. Use pagination for larger result sets.
string
Encoded query to filter configuration items. Syntax: <col_name><operator><value>. Operators: ’=’ (exact match), ’!=’ (not equal), ’^’ (AND), ‘^OR’ (OR), LIKE, STARTSWITH, ENDSWITH. Example: operational_status=1^environment=Production
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,name,ip_address,operational_status’
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to paginate through results.
string
Determines the format of field values in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CMDB_INSTANCE_BY_IDRetrieves a single CMDB configuration item (CI) by its class name and sys_id, including its attributes and relationship information. Use this action when you need to fetch detailed information about a specific configuration item from ServiceNow’s CMDB, such as its attributes (name, IP, status, etc.) and both its inbound (dependents) and outbound (dependencies) relationships with other CIs. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the CMDB configuration item to retrieve. This is a 32-character hexadecimal string that uniquely identifies the CI record. Example: ‘00a96c0d3790200044e0bfc8bcbe5db4’
string
required
Name of the CMDB CI class (table) to query. Examples: ‘cmdb_ci’, ‘cmdb_ci_linux_server’, ‘cmdb_ci_apache’, ‘cmdb_ci_service_discovered’. The class name determines which type of configuration item to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CMDB_METARetrieves metadata and schema information for a specified CMDB (Configuration Management Database) class. Use this action when you need to discover the field structure, data types, mandatory fields, and relationships of a CMDB class before performing queries or updates. This is useful for understanding what fields are available for filtering, display, or modification operations. The user must have the ITIL role to access CMDB metadata.

Input Parameters

string
required
The CMDB class name to retrieve metadata for. Common classes include: ‘cmdb_ci’ (base CI class), ‘cmdb_ci_server’, ‘cmdb_ci_database’, ‘cmdb_ci_service’, ‘cmdb_ci_web_server’, ‘cmdb_ci_linux_server’, ‘cmdb_ci_win_server’, ‘cmdb_ci_appl’.
string
Determines the format of field values in the response. ‘false’: Returns actual database values. ‘true’: Returns display values. ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_CMP_CATALOG_API_SERVICESRetrieves catalog items from the ServiceNow sc_cat_item table using the Table API. Supports encoded-query filtering, field selection, pagination, and display value options for browsing and searching catalog offerings.

Input Parameters

string ("desktop" | "mobile" | "both")
UI view for which to render the data (desktop, mobile, or both).
integer
Maximum number of catalog service items to return in the response. Use pagination parameters (sysparm_offset) for retrieving larger result sets. Note: Unusually large values can impact system performance.
string
Encoded query string to filter catalog items. Syntax: <col_name><operator><value>. Operators: = (equals), != (not equals), ^ (AND), ^OR (OR), LIKE, STARTSWITH, ENDSWITH. Example: active=true^price>0 Example: retired=false^availability=available
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,name,short_description,price’
integer
Starting record index for which to begin retrieving catalog items. Use this value to paginate through results. For example, set sysparm_offset=0 for the first page, then sysparm_offset=sysparm_limit for the next page.
boolean
Flag that indicates whether to execute a select count(*) query to return the number of rows.
string ("true" | "false" | "all")
Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
string
Name of the category to use when querying. Restricts results to items belonging to the specified category.
Flag that indicates whether to exclude Table API links for reference fields.
boolean
Flag that indicates whether to remove the Link header from the response. The Link header provides URLs to relative pages in the record set for pagination. Set to ‘true’ to remove the Link header, ‘false’ to include it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_EMAILRetrieves a specific email record from ServiceNow’s Email [sys_email] table by its sys_id. Use this action when you need to fetch detailed information about a particular email message, including its subject, body content, sender, recipients, status, and timestamps. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the email record to retrieve. This is a 32-character hexadecimal string that uniquely identifies the email in the sys_email table. Example: ‘1228ed5283333210dd2dc2dfeeaad376’
string
Comma-separated list of fields to return in the response. Invalid field names are ignored.
string
Determines the type of data returned, either ‘true’ for display values or ‘false’ for actual values. Display values are manipulated based on user or system settings. Choice fields: Returns descriptive text instead of numeric values. Date fields: Returns formatted date based on user’s time zone instead of UTC. Reference fields: Returns display field of referenced record instead of sys_id.
Flag that indicates whether to exclude Table API links for reference fields. Set to true to exclude links.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_GLOBAL_USER_ROLE_INHERITANCERetrieves a ServiceNow user’s directly granted and inherited roles for reviewing role assignments and troubleshooting access. Specify a user by sys_id or user ID, or omit both to request the authenticated user’s inheritance; querying other users requires appropriate access.

Input Parameters

string
The sys_id of the user whose role inheritance to retrieve. If not provided, returns the role inheritance for the authenticated user making the request. You must have the appropriate role (such as ‘admin’ or a role with user_role_inheritance API access) to query role inheritance for users other than yourself.
string
The user ID (user_name) of the user whose role inheritance to retrieve. This is the login name or user ID of the ServiceNow user. Either sys_id or user_id can be used to specify the user, but not both. If neither is provided, returns the role inheritance for the authenticated user.
boolean
When set to true, returns additional details about the groups through which roles are inherited. When false (default), only role names and basic information are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_IMPORTRetrieves the specified import staging record and its associated target records. Use this action when you need to fetch a specific import staging record to view its current state, check import status, or retrieve the imported data before it is loaded into the target table. This is useful for auditing import processes, debugging failed imports, or monitoring data import progress. Common use cases: - Check the status of a specific import record - View the raw imported data for debugging - Verify that data was correctly staged before transformation - Retrieve import metadata (source, target table, batch info)

Input Parameters

string
required
The sys_id of the import staging record to retrieve. This is the unique identifier assigned to the staging record.
string
required
Name of the import set staging table from which to retrieve the record. This is the table where imported data is staged before being transformed and loaded into target tables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_INCIDENT_BY_IDRetrieves a specific incident from ServiceNow by its sys_id. Use this action when you need to fetch detailed information about a particular incident, including its state, priority, caller, assignment details, and resolution information. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the incident to retrieve. This is a 32-character hexadecimal string that uniquely identifies the incident record. Example: ‘46b66a40a9fe198101f243dfbc79033d’
string
Comma-separated list of fields to return in the response. If not specified, all fields are returned.
boolean
Determines whether to return actual database values (false) or display values (true) for reference fields.
Determines whether reference links should be excluded from the response. Set to true to exclude reference links.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_INCIDENT_BY_ID2Retrieves a specific ServiceNow incident by sys_id using the Table API. The response contains a limited set of incident fields, including state, priority, caller and assigned user.

Input Parameters

string
required
The unique system ID (sys_id) of the incident to retrieve. This is a 32-character hexadecimal string that uniquely identifies the incident record. Example: ‘46b9490da9fe1981003c938dab89bda3’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_INCIDENTSRetrieves incidents from the ServiceNow incident table with optional encoded filtering, pagination and field selection. Returned records are limited to the tool’s supported incident fields.

Input Parameters

integer
Maximum number of incident records to return. Use pagination for larger result sets.
string
Encoded query to filter incidents. Syntax: <col_name><operator><value>. Operators: ’=’ (exact match), ’!=’ (not equal), ’^’ (AND), ‘^OR’ (OR), LIKE, STARTSWITH, ENDSWITH. Example: state=2^priority=1 (active critical incidents)
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,number,state,priority,short_description’
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to paginate through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_PA_SCORECARDSRetrieves Performance Analytics scorecards and indicator details from the Analytics Hub, optionally filtering by indicator UUID and including scores. Supports page and per-page parameters.

Input Parameters

integer
Page number to retrieve when listing scorecards.
string
UUID of the indicator to retrieve. When provided, returns details for a specific indicator.
integer
Maximum scorecards to return per page, from 1 to 100.
boolean
Flag that indicates whether to include score values in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_RECORDSRetrieves multiple records from a specified ServiceNow table with optional filtering and pagination. Use this action to query and fetch records from any ServiceNow table (e.g., incident, sys_user, problem). Supports filtering via sysparm_query, field selection, pagination, and display value options.

Input Parameters

string
required
The name of the table from which to retrieve the record.
string ("desktop" | "mobile" | "both")
UI view for which to render the data. Determines the fields returned in the response.
integer
Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval. This limit is applied before ACL evaluation. If no records return, including records you have access to, rearrange the record order so records you have access to return first. Note: Unusually large sysparm_limit values can impact system performance.
string
Encoded query used to filter the result set. Syntax: <col_name><operator><value>. All parameters are case-sensitive. Operators: = (exact match), != (not equal), ^ (AND), ^OR (OR), LIKE (contains string), STARTSWITH, ENDSWITH (string fields only). Multiple conditions: <col_name><operator><value>^<col_name><operator><value>. Example: active=true^priority=1. Sorting: Append ORDERBY<col_name> or ORDERBYDESC<col_name>. Example: active=true^ORDERBYnumber^ORDERBYDESCcategory.
string
Comma-separated list of fields to return in the response. Invalid fields are ignored.
integer
Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to ‘0’. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records. Don’t pass a negative number in the sysparm_offset parameter.
string
DEPRECATED: This parameter does not work in the ServiceNow Table API and will be ignored. Use ‘sysparm_query’ instead for filtering records. Example: sysparm_query=‘active=true^priority=1’ for multiple conditions.
boolean
Flag that indicates whether to execute a select count(*) query on the table to return the number of rows in the associated table.
string ("true" | "false" | "all")
Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. If returning display values, the value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user’s time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user’s encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record.
string
Name of the category to use for queries.
boolean
Flag that indicates whether to restrict the record search to only the domains for which the logged in user is configured. Valid values: false (Exclude the record if it is in a domain that the currently logged in user is not configured to access), true (Include the record even if it is in a domain that the currently logged in user is not configured to access). Note: The sysparm_query_no_domain parameter is available only to system administrators or users who have the query_no_domain_table_api role.
Flag that indicates whether to exclude Table API links for reference fields.
boolean
Flag that indicates whether to remove the Link header from the response. The Link header provides various URLs to relative pages in the record set which you can use to paginate the returned record set. Valid values: true (Remove the Link header from the response), false (Do not remove the Link header from the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_RECORD_TYPESRetrieves all available table record types from the ServiceNow instance using the Table API documentation endpoint. Use this action when you need to discover all available tables and their record types in a ServiceNow instance before performing queries, creating records, or understanding the data structure available in the instance. This is useful for dynamic table selection and exploration purposes. This action queries the /api/now/doc/table/schema endpoint which returns metadata about all tables accessible in the ServiceNow instance, including both system tables and custom tables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_ROWSRetrieves records from a specified ServiceNow table using the Table API v2. Use this action when you need to fetch one or more records from any ServiceNow table (e.g., incident, task, problem, change_request). When sys_id is provided, retrieves a single record. Without sys_id, retrieves multiple records up to the sysparm_limit. Supports filtering via sysparm_query, field selection, pagination, and display value options.

Input Parameters

string
The unique system ID (sys_id) of the record to retrieve. If provided, fetches a single record by its sys_id. If not provided, returns all records from the table (up to sysparm_limit).
string
required
The name of the ServiceNow table to query (e.g., ‘incident’, ‘task’, ‘sys_user’, ‘problem’). Use the table name without the ‘sys_ prefix for base tables.
integer
Maximum number of records to return. For requests that exceed this number of records, use pagination via sysparm_offset. Note: Unusually large values can impact system performance.
string
Encoded query to filter results. Syntax: <col_name><operator><value>. Operators: ’=’ (exact match), ’!=’ (not equal), ’^’ (AND), ‘^OR’ (OR), LIKE, STARTSWITH, ENDSWITH. Example: state=1^priority=2
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,number,state,priority’
integer
Starting record index for pagination. Set to sysparm_offset + sysparm_limit to retrieve subsequent pages of results.
string
Determines the type of data returned. ‘false’: Returns actual database values. ‘true’: Returns display values (more human-readable). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.
boolean
Set to true to exclude the Link header from the response for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVICATALOG_ITEMS_BY_IDRetrieves a specific Service Catalog item from ServiceNow using its sys_id. Use this action when you need to fetch detailed information about a particular catalog item, including its name, description, associated categories, variables, client scripts, and display settings. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the catalog item to retrieve. This is a 32-character hexadecimal string that uniquely identifies the catalog item. Example: ‘011f117a9f3002002920bde8132e7020’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVIC_CATALOG_ITEM_VARIABLESRetrieves the list of variables defined for a ServiceNow Service Catalog item. Use this action when you need to fetch all variables associated with a catalog item, such as when building dynamic forms, validating required inputs, or understanding what information a user must provide when ordering an item. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the catalog item to retrieve variables for. This is a 32-character hexadecimal string that uniquely identifies the catalog item. Example: ‘011f117a9f3002002920bde8132e7020’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVICE_CATALOG_CARTRetrieves the details of all items within the logged-in user’s Service Catalog shopping cart. This action fetches the current contents of the shopping cart, including item details, quantities, prices, and any selected variables/options. The cart is associated with the authenticated user making the request. Use this action when you need to review items before submitting an order, verify quantities, or check selected options. This is a read-only operation that does not modify any data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVICE_CATALOG_CART_DELIVERY_ADDRESSRetrieves the delivery/shipping address configured for a user’s Service Catalog shopping cart. Use this action when you need to fetch the delivery address information associated with a user’s ServiceNow Service Catalog cart. This is useful for verifying delivery details before placing an order or for displaying address information to users. The action returns address fields including street, city, state, zip code, country, and contact information such as phone and email.

Input Parameters

string
required
The unique identifier of the user whose delivery address to retrieve. This can be the user’s sys_id (a 32-character hexadecimal string) or the user’s username. For guest users, this is typically ‘guest’. Example: ‘guest’ or ‘681ccaf9c0a8016400b98a908cbe7df3’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVICE_CATALOG_CATALOG_BY_IDRetrieves the available information for a specified service catalog by its sys_id. Use this action when you need to fetch detailed information about a specific service catalog in ServiceNow, including its title and description. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the service catalog to retrieve. This is a 32-character hexadecimal string that uniquely identifies the catalog. Example: ‘742ce428d7211100f2d224837e61036d’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVICE_CATALOG_CATALOG_CATEGORIESRetrieves the list of available categories for a specified ServiceNow Service Catalog. Use this action when you need to fetch the categories available within a specific service catalog, such as displaying available categories to users or navigating through catalog items. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the Service Catalog catalog to retrieve categories from. This is a 32-character hexadecimal string that uniquely identifies the catalog. Example: ‘742ce428d7211100f2d224837e61036d’
integer
Maximum number of categories to return. Defaults to 25 if not specified.
integer
Number of records to skip for pagination. Use with sysparm_limit to paginate through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVICE_CATALOG_CATEGORY_BY_IDRetrieves the available information for a specified service catalog category by its sys_id. Use this action when you need to fetch detailed information about a specific service catalog category in ServiceNow, including its title, description, subcategories, and item count. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the service catalog category to retrieve. This is a 32-character hexadecimal string that uniquely identifies the category. Example: ‘d258b953c611227a0146101fb1be7c31’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVICE_CATALOG_ITEM_DELEGATIONVerifies whether a delegated user has access to a specific ServiceNow Service Catalog item. This action checks if a delegated user (identified by user_sys_id) is authorized to order or access a particular catalog item (identified by item_sys_id). Use this action to validate delegation permissions before attempting to submit orders on behalf of another user. Use this action when you need to verify delegation permissions for Service Catalog items, such as checking if a manager can order items on behalf of their team members or if an assistant has been granted proper access to order items for someone else.

Input Parameters

string
required
The unique system ID (sys_id) of the Service Catalog item to check delegation access for. This is a 32-character hexadecimal string that uniquely identifies the catalog item. Example: ‘0123456789abcdef0123456789abcdef’
string
required
The unique system ID (sys_id) of the delegated user to verify access for. This is a 32-character hexadecimal string that uniquely identifies the user. Example: ‘fedcba9876543210fedcba9876543210’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVICE_CATALOG_ITEMS_LISTRetrieves a list of catalog items from ServiceNow’s Service Catalog API. Use when you need to browse available service catalog offerings, search for specific items by name or description, filter items by category or catalog, or retrieve catalog item details including pricing, availability, and metadata. Supports filtering via category, catalog, and text search parameters.

Input Parameters

string
Text search filter for catalog item name and short description. Searches across item names and descriptions to find matching items.
integer
Maximum number of catalog items to return. Use this parameter to limit response size. For requests that exceed this number, use pagination to retrieve additional records. Note: Unusually large values can impact system performance.
string
Filter catalog items by catalog sys_id or name. Returns only items that belong to the specified service catalog.
string
Filter catalog items by category sys_id or name. Returns only items that belong to the specified category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SERVICE_CATALOG_WISHLIST_LISTRetrieves the list of items in the logged-in user’s ServiceNow Service Catalog wishlist. Use this action when you need to fetch the wishlist items for the currently authenticated user in ServiceNow’s Service Catalog. This is useful for displaying a user’s saved items, checking what items they have bookmarked, or preparing to add items to a cart. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

integer
Maximum number of wishlist items to return. Defaults to 25 if not specified.
integer
Number of records to skip for pagination. Use with sysparm_limit to paginate through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CDM_SHARED_LIBRARIES_UPLOAD_STATUSRetrieves the current status of a ServiceNow shared library upload by upload ID. Use it to check whether an upload is still in progress, has completed, or has failed. This is a read-only operation.

Input Parameters

string
required
The unique identifier of the upload operation to retrieve the status for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_BY_IDRetrieves a ServiceNow change request by sys_id. The returned details are limited to the number, short description, state, sys_id and type.

Input Parameters

string
required
The unique system ID (sys_id) of the change request to retrieve. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘8866498dc37a3610eb10d8477d013161’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_EMERGENCY_BY_IDRetrieves a specific emergency change request from ServiceNow using its sys_id. Use this action when you need to fetch detailed information about a particular emergency change request, including its state, risk level, priority, implementation details, approval status, and schedule. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the emergency change request to retrieve. This is a 32-character hexadecimal string that uniquely identifies the emergency change request. Example: ‘d53e72ec73d423002728660c4cf6a78d’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_EMERGENCY_LISTRetrieves emergency change requests from ServiceNow with encoded-query filtering, field selection, pagination, and display value options. Returned records lacking either sys_id or number are omitted, so field selections should include both.

Input Parameters

string
UI view for which to render the data. Determines the fields returned in the response. Valid values: desktop, mobile, both.
integer
Maximum number of emergency change records to return. For requests that exceed this number of records, use pagination via sysparm_offset. Note: Unusually large sysparm_limit values can impact system performance.
string
Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>. Supports operators: =, !=, ^ (AND), ^OR, LIKE, STARTSWITH, ENDSWITH. Example: sysparm_query=state!=4^priority=1 Can also use ORDERBY/ORDERBYDESC for sorting. Example: sysparm_query=ORDERBYDESCopened_at
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state,priority’). Invalid fields are ignored. If not specified, all fields are returned.
integer
Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. For example, if sysparm_limit is 25, use sysparm_offset=25 to get the next 25 records.
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Flag that indicates whether to exclude Table API links for reference fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_LISTRetrieves one or more change requests from ServiceNow based on specified filter criteria. Use when you need to query change management records, monitor pending changes, find changes by state or type, or list all changes assigned to a specific user or group. Supports filtering via encoded queries, pagination via limit/offset, and returns rich change request details including state, priority, dates, assignments, and approvals.

Input Parameters

integer
Maximum number of change request records to return. Use sysparm_offset for pagination to retrieve additional records. Note: Unusually large values can impact system performance.
string
Encoded query to filter change requests. Syntax: <col_name><operator><value>. Supports operators: = (exact match), != (not equal), ^ (AND), ^OR (OR), LIKE (contains string), STARTSWITH, ENDSWITH. Example: sysparm_query=state!=7^active=true You can also use ORDERBY and ORDERBYDESC to sort results, e.g., ORDERBYDESCopened_at to sort by most recently opened.
integer
Starting record index for pagination. Use sysparm_offset + sysparm_limit to page through large result sets. For example, first call with offset=0, next call with offset=sysparm_limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_MODEL_BY_IDRetrieves a specific change model from ServiceNow using its sys_id. Use this action when you need to fetch detailed information about a particular change model, including its name, description, type, category, workflow, and other configuration settings. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the change model to retrieve. This is a 32-character hexadecimal string that uniquely identifies the change model. Example: ‘7840d2515323101034d1ddeeff7b12a6’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_MODEL_LISTRetrieves one or more change models from ServiceNow’s Change Management API. Use this action when you need to fetch change model definitions that define the structure and workflow for change requests. Change models determine the type of change (normal, standard, emergency), associated workflows, and other configuration. This is a read-only operation that does not modify any data in ServiceNow. You can retrieve a specific change model by sys_id, or list all change models with optional filtering and pagination.

Input Parameters

string
The unique system ID (sys_id) of a specific change model to retrieve. If specified, returns only the change model with this sys_id. If not specified, returns all change models (with optional filtering). Example: ‘8766498dc37a3610eb10d8477d013161’
integer
Maximum number of change models to return in the response. Defaults to 25 if not specified. Use this with sysparm_offset for pagination. Note: Unusually large limit values can impact system performance.
string
Encoded query string to filter change models. Uses ServiceNow query syntax. Example: ‘active=true’ or ‘nameLIKEstandard’. Supports operators: =, !=, ^ (AND), ^OR, LIKE, STARTSWITH, ENDSWITH. Example: ‘active=true^nameLIKEemergency’
integer
Starting record index for pagination. Use this to paginate through results. For example, set sysparm_offset to 25 to retrieve the second page of results when combined with sysparm_limit=25.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_NORMAL_BY_IDRetrieves a specific normal change request from ServiceNow using its sys_id via the Change Management REST API. Use when you need to fetch detailed information about a particular normal change request, including its state, type, priority, dates, assignments, and approvals. This is a read-only operation that does not modify any data in ServiceNow. The action specifically targets change requests of type ‘normal’ — if the provided sys_id does not correspond to a normal change request, a 404 error will be returned.

Input Parameters

string
required
The unique system ID (sys_id) of the normal change request to retrieve. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘a9e9c33dc61122760072455df62663d2’. The change request must exist and be of type ‘normal’, or a 404 error will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_NORMAL_LISTRetrieves one or more normal change requests from ServiceNow’s Change Management API. Use this action when you need to query normal change management records, monitor pending normal changes, find normal changes by state or type, or list all normal changes assigned to a specific user or group. Supports filtering via encoded queries, pagination via limit/offset, and returns rich normal change request details including state, priority, dates, assignments, and approvals. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

integer
Maximum number of normal change request records to return. Use sysparm_offset for pagination to retrieve additional records. Note: Unusually large values can impact system performance.
string
Encoded query to filter normal change requests. Syntax: <col_name><operator><value>. Supports operators: = (exact match), != (not equal), ^ (AND), ^OR (OR), LIKE (contains string), STARTSWITH, ENDSWITH. Example: sysparm_query=state!=7^active=true You can also use ORDERBY and ORDERBYDESC to sort results, e.g., ORDERBYDESCopened_at to sort by most recently opened.
integer
Starting record index for pagination. Use sysparm_offset + sysparm_limit to page through large result sets. For example, first call with offset=0, next call with offset=sysparm_limit.
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_STANDARD_BY_IDRetrieves a specific standard change request from ServiceNow using its sys_id. Use this action when you need to fetch detailed information about a particular standard change request, including its state, phase, description, assignments, and schedule. This is a read-only operation that does not modify any data in ServiceNow. Standard changes are pre-approved changes following a standardized process defined by the organization.

Input Parameters

string
required
The unique system ID (sys_id) of the standard change request to retrieve. This is a 32-character hexadecimal string that uniquely identifies the standard change request. Example: ‘eaf5d21347c12200e0ef563dbb9a7109’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_STANDARD_LISTRetrieves standard change requests from ServiceNow with query filtering, field selection, pagination, and display value options. Records missing either sys_id or number are omitted from the returned results, including when field selection excludes them.

Input Parameters

string
UI view for which to render the data. Determines the fields returned in the response. Valid values: desktop, mobile, both.
integer
Maximum number of standard change records to return. For requests that exceed this number of records, use pagination via sysparm_offset. Note: Unusually large sysparm_limit values can impact system performance.
string
Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>. Supports operators: =, !=, ^ (AND), ^OR, LIKE, STARTSWITH, ENDSWITH. Example: sysparm_query=state!=4^priority=1 Can also use ORDERBY/ORDERBYDESC for sorting. Example: sysparm_query=ORDERBYDESCopened_at
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state,priority’). Invalid fields are ignored. If not specified, all fields are returned.
integer
Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. For example, if sysparm_limit is 25, use sysparm_offset=25 to get the next 25 records.
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Flag that indicates whether to exclude Table API links for reference fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_STANDARD_TEMPLATE_BY_IDRetrieves a specific standard change template from ServiceNow using its sys_id. Use this action when you need to fetch detailed information about a particular standard change template, including its name, description, category, implementation plan, test plan, risk assessment, and other predefined fields. This is a read-only operation that does not modify any data in ServiceNow. This action complements the list action — use the list action to discover template sys_ids, then use this action to retrieve full details of a specific template by its sys_id.

Input Parameters

string
required
The unique system ID (sys_id) of the standard change template to retrieve. This is a 32-character hexadecimal string that uniquely identifies the template. Example: ‘508e02ec47410200e90d87e8dee49058’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_STANDARD_TEMPLATE_LISTRetrieves one or more standard change templates from ServiceNow’s Change Management API. Use this action when you need to query standard change templates that provide pre-defined structures for creating standard change requests. Standard change templates help ensure consistency in change implementation by providing predefined fields such as category, implementation plan, test plan, and risk assessment. This is a read-only operation that does not modify any data in ServiceNow. Common use cases: Listing available templates for a change request, filtering templates by category or active status, or retrieving templates for display in a user interface.

Input Parameters

integer
Maximum number of standard change template records to return. Defaults to 25 if not specified. Use sysparm_offset for pagination to retrieve additional records. Note: Unusually large limit values can impact system performance.
string
Encoded query to filter standard change templates. Uses ServiceNow query syntax to filter results. Example: ‘active=true’ to only return active templates, or ‘category=software’ to filter by category. Supports operators: = (exact match), != (not equal), ^ (AND), ^OR (OR), LIKE (contains string), STARTSWITH, ENDSWITH. Can also use ORDERBY/ORDERBYDESC for sorting, e.g., ORDERBYDESCname.
integer
Starting record index for pagination. Use sysparm_offset + sysparm_limit to page through large result sets. For example, first call with offset=0, next call with offset=sysparm_limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CHG_REST_CHANGE_TASKRetrieves one or more tasks associated with a specific ServiceNow change request. Use this action when you need to fetch the tasks or subtasks related to a change request, such as to view task status, track progress, or list all work items assigned to a change. This is a read-only operation that does not modify any data in ServiceNow. The endpoint returns tasks that are linked to the change request via the task_for field or as child records in the change management workflow.

Input Parameters

string
required
The unique system ID (sys_id) of the change request whose tasks to retrieve. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘46e9b4afa9fe198101026e122b85f442’. The change request must exist, or a 404 error will be returned.
integer
Maximum number of task records to return. Use sysparm_offset for pagination to retrieve additional records. Note: Unusually large values can impact system performance.
string
Comma-separated list of fields to return in the response. Invalid fields are ignored. If not specified, all fields are returned. Example: ‘number,short_description,state,assigned_to’
integer
Starting record index for pagination. Use sysparm_offset + sysparm_limit to page through large result sets. For example, first call with offset=0, next call with offset=sysparm_limit.
string
Determines the type of data returned. ‘true’: Returns display values (names for references, text labels for choices). ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘all’: Returns both display and actual values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CICD_APP_BATCH_RESULTSRetrieves the results of a batch application install operation from ServiceNow CI/CD. Use this action when you need to check the status and details of a previously initiated batch application install or deployment operation. The result_id should be obtained from the response of the batch operation that was initiated. This is a read-only operation that does not modify any data in ServiceNow. This action is particularly useful for tracking the progress of multi-app deployments or installations, checking individual item success/failure status, and identifying any errors that occurred during the batch operation.

Input Parameters

string
required
The unique identifier of the batch operation result to retrieve. This is a 32-character hexadecimal string that identifies the batch results record. Obtain this value from the response of a previous batch install operation. Example: ‘bb23487e833bf210dd2dc2dfeeaad3c4’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CICD_INSTANCE_SCAN_RESULTRetrieves the current progress and status of a CI/CD instance scan operation in ServiceNow. Use this action when you need to check the status of an ongoing or completed ServiceNow instance scan that validates configurations, detects issues, or checks compliance. The progress_id should be obtained from the response of a previously initiated instance scan operation. This is a read-only operation that queries the current scan status without modifying any data. This action is typically used in a polling loop after initiating an instance scan to determine when the scan completes and to retrieve the scan results once finished.

Input Parameters

string
required
The unique identifier for the instance scan progress operation to retrieve. This ID is typically returned from a previous instance scan initiation response. Example: ‘test-progress-id-12345’ or a system-generated GUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CICD_PROGRESSRetrieves the current progress and status of a CI/CD operation in ServiceNow. Use this action when you need to check the status of an ongoing CI/CD pipeline execution, commit operation, or deployment. The progress_id should be obtained from a previous CI/CD operation response. This is a read-only operation that queries the current status without modifying any data.

Input Parameters

string
required
The unique identifier for the CI/CD progress operation to retrieve. This ID is typically returned from a previous CI/CD operation such as a pipeline execution, commit, or deployment. Example: ‘test’ or a system-generated GUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_SN_CICD_TESTSUITE_RESULTSRetrieves the results of a test suite run from ServiceNow CI/CD based on the result ID. Use this action when you need to check the status, completion percentage, or final outcome of a previously initiated test suite execution in the ServiceNow CI/CD pipeline. The result_id should be obtained from the response of a test suite run initiation action. This is a read-only operation that queries the current state without modifying any data.

Input Parameters

string
required
The unique identifier of the test suite result to retrieve. This ID is returned when a test suite run is initiated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_STATSRetrieves aggregate statistics for a specified ServiceNow table, including COUNT, AVG, MIN, MAX, and SUM calculations. Use this action when you need to perform aggregate queries on ServiceNow tables to get statistical summaries (e.g., count of incidents by state, average priority, min/max values for specific fields, or grouped aggregations). Supports filtering records with sysparm_query, calculating various aggregates, grouping results, and filtering aggregated results with the having clause.

Input Parameters

string
required
The name of the table to aggregate statistics from (e.g., ‘incident’, ‘sys_user’, ‘task’).
boolean
Set to true to return the count of records matching the query.
string
Encoded query string to filter records before aggregating. Syntax: <col_name><operator><value>. Operators: = (equals), != (not equals), ^ (AND), ^OR (OR), LIKE, STARTSWITH, ENDSWITH. Example: active=true^priority=1
string
Having clause to filter aggregated results based on aggregate values. Syntax: <aggregate_function><operator><value>. Example: ‘count>10’ returns only groups with count greater than 10.
string
Comma-separated list of fields to group results by. When specified, aggregate functions are calculated per group. Example: ‘state,active’ groups results by state and active status.
string
Comma-separated list of numeric fields to calculate average for. Example: ‘priority,urgency’ calculates average priority and urgency values.
string
Comma-separated list of fields to calculate maximum value for. Example: ‘priority,state’ returns maximum priority and state values.
string
Comma-separated list of fields to calculate minimum value for. Example: ‘priority,state’ returns minimum priority and state values.
string
Comma-separated list of numeric fields to calculate sum for. Example: ‘priority’ returns sum of all priority values.
string ("true" | "false" | "all")
Display value options for stats query responses

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_TABLE_BY_IDRetrieves multiple records from a specified ServiceNow table using the Table API. Use this action when you need to query and fetch records from any ServiceNow table (e.g., incident, sys_user, problem, change_request). Supports filtering via sysparm_query, field selection via sysparm_fields, and pagination via sysparm_limit and sysparm_offset. This action performs a GET request and is read-only.

Input Parameters

string
required
The name of the table from which to retrieve records (e.g., ‘incident’, ‘sys_user’, ‘problem’, ‘change_request’).
integer
Maximum number of records to return. Use with sysparm_offset to paginate through results.
string
Encoded query used to filter the result set. Syntax: <col_name><operator><value>. All parameters are case-sensitive. Operators: = (exact match), != (not equal), ^ (AND), ^OR (OR), LIKE (contains string), STARTSWITH, ENDSWITH (string fields only). Multiple conditions: <col_name><operator><value>^<col_name><operator><value>. Example: active=true^priority=1. Sorting: Append ORDERBY<col_name> or ORDERBYDESC<col_name>. Example: active=true^ORDERBYnumber^ORDERBYDESCcategory.
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored.
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to retrieve the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_TABLE_BY_ID2Retrieves the record identified by the specified sys_id from the specified table. Use this action when you need to fetch a single record from any ServiceNow table (e.g., incident, sys_user, problem) by providing its table name and unique sys_id. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
Sys_id of the record to retrieve. This is a 32-character hexadecimal string that uniquely identifies the record.
string
required
Name of the table to retrieve the record from.
string
UI view to use for field selection.
string
Comma-separated list of fields to return.
string ("true" | "false" | "all")
Determines the type of data returned in the response.
Exclude reference links in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_TABLE_INCIDENT_BY_IDRetrieves a single incident record from ServiceNow by its sys_id using the Table API. Use this action when you need to fetch detailed information about a specific incident from ServiceNow’s incident table, including its state, priority, assignment, description, and all other standard incident fields. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the incident record to retrieve. This is a 32-character hexadecimal string that uniquely identifies the incident. Example: ‘1c832706732023002728660c4cf6a7b9’
string ("desktop" | "mobile" | "both")
UI view for which to render the data. Determines the fields returned in the response.
string
Comma-separated list of fields to return in the response. Invalid fields are ignored.
string ("true" | "false" | "all")
Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. If returning display values, the value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user’s time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user’s encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record.
string
Name of the category to use for queries.
Flag that indicates whether to exclude Table API links for reference fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_TABLE_INCIDENT_LISTLists ServiceNow incident records using the Table API, with encoded-query filtering, field selection and a configurable result limit. Results can include state, priority, assignment, timestamps and SLA information.

Input Parameters

integer
Maximum number of incident records to return. Use pagination for larger result sets.
string
Encoded query used to filter the result set. Syntax: <col_name><operator><value>. Supports operators: ’=’ (exact match), ’!=’ (not equal), ’^’ (AND), ‘^OR’ (OR), LIKE (contains), STARTSWITH, ENDSWITH. Example: state=2^priority=1 to get active high-priority incidents. Use ORDERBY or ORDERBYDESC to sort results, e.g., ORDERBYDESCopened_at.
string
Comma-separated list of fields to return in the response. Invalid fields are silently ignored.
boolean
Determines if system references should be returned as actual values (false) or display values (true).
Determines whether to exclude reference links from the response. Set to true to simplify the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_TABLESRetrieves one or more records from a ServiceNow table using the Table API (GET /api/now/v2/table). Use this action when you need to query and list records from any ServiceNow table, such as finding incidents, tasks, change requests, users, or any other table record. Supports filtering via encoded queries (sysparm_query), field selection (sysparm_fields), pagination via sysparm_limit and sysparm_offset, and display value options. This is a generic table listing action that works with any table name specified in the request. For a list of available tables in the instance, consider using the GetRecordTypes action first to discover table names and labels before querying specific tables.

Input Parameters

string
The name of the ServiceNow table to query (e.g., ‘incident’, ‘task’, ‘sys_user’, ‘change_request’). If not specified, the API may return records from a default or accessible table. Common tables: ‘incident’, ‘task’, ‘sys_user’, ‘cmdb_ci’, ‘change_request’, ‘problem’, ‘kb_knowledge’.
integer
Maximum number of records to return in the response. For result sets larger than this limit, use sysparm_offset to paginate. Example: sysparm_offset=0 returns records 1-N, then sysparm_offset=N returns the next batch.
string
Encoded query string to filter the records returned. Syntax: <col_name><operator><value>. Operators: ’=’ (exact match), ’!=’ (not equal), ’^’ (AND), ‘^OR’ (OR), LIKE (contains), STARTSWITH, ENDSWITH. Example: active=true^priority=1 to get active high-priority records. Use ORDERBY or ORDERBYDESC to sort results, e.g., ORDERBYDESCopened_at.
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,name,state,priority,short_description’
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to page through large result sets. For example, to get records 101-200, set sysparm_offset=100 with sysparm_limit=100.
boolean
Flag that indicates whether to execute a select count(*) query on the table to return the number of rows in the associated table.
string ("true" | "false" | "all")
Display value options for table query responses
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_USERRetrieves a specific user record from ServiceNow using its sys_id. Use this action when you need to fetch detailed information about a particular user, such as their contact details, department, location, manager, or account status. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

string
required
The unique system ID (sys_id) of the user record to retrieve. This is a 32-character hexadecimal string that uniquely identifies the user in ServiceNow. Example: ‘02826bf03710200044e0bfc8bcbe5d3f’
string
Comma-separated list of fields to return in the response. Invalid fields are ignored.
boolean
Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. If returning display values, the value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user’s time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user’s encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record.
Flag that indicates whether to exclude Table API links for reference fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_GET_USERSLists user records from the ServiceNow sys_user table for tasks such as finding active users or users in a department. Supports encoded-query filtering, field selection, limit/offset pagination, and actual, display, or both value formats. This is a read-only operation.

Input Parameters

integer
Maximum number of user records to return. Use pagination (sysparm_offset) for result sets larger than this limit.
string
Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>. Operators: ’=’ (exact match), ’!=’ (not equal), ’^’ (AND), ‘^OR’ (OR), LIKE, STARTSWITH, ENDSWITH. Example: active=true^emailLIKEsomething.com
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,user_name,first_name,last_name,email,active’
integer
Starting record offset for pagination. Use with sysparm_limit to paginate through results.
string
Determines the format of field values in the response. ‘false’: Returns actual database values (sys_ids for references). ‘true’: Returns display values (names for references). ‘all’: Returns both display and actual values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_LIST_ATTACHMENTSRetrieves metadata for multiple ServiceNow attachments, with an encoded query to filter by attachment properties and a limit on the number returned. File content must be downloaded separately using the sys_id or download link.

Input Parameters

integer
Limit to be applied on pagination. Use this parameter to limit the number of attachment records returned. For requests that exceed this limit, use sysparm_offset to paginate through results. Note: Unusually large sysparm_limit values can impact system performance.
string
Encoded query to filter attachments. Queries are relative to the sys_attachment table. Syntax follows ServiceNow encoded query format: <column><operator><value>. Operators: = (equals), != (not equals), ^ (AND), ^OR (OR), LIKE (contains), STARTSWITH, ENDSWITH. Examples: file_nameLIKEreport - attachments with ‘report’ in the file name; table_name=incident - attachments on incident records; content_type=image%2Fpng - PNG images; size_bytes>1000000 - files larger than 1MB. Use ORDERBY or ORDERBYDESC for sorting: ORDERBYfile_name, ORDERBYDESCsys_created_on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_LIST_CMDB_CI_LINUX_SERVERSRetrieves Linux server configuration items (CIs) from the ServiceNow CMDB using the cmdb_ci_linux_server class. Use this action when you need to query Linux servers from the CMDB, such as retrieving all Linux servers for inventory reporting, filtering by operational status, environment, or other attributes. Supports filtering via sysparm_query and pagination via sysparm_limit and sysparm_offset. This is a read-only operation that does not modify any data in ServiceNow.

Input Parameters

integer
Maximum number of Linux server records to return. Use pagination for larger result sets.
string
Encoded query to filter Linux servers. Syntax: <col_name><operator><value>. Operators: ’=’ (exact match), ’!=’ (not equal), ’^’ (AND), ‘^OR’ (OR), LIKE, STARTSWITH, ENDSWITH. Example: operational_status=1^environment=Production
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,name,ip_address,operational_status’
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to paginate through results.
string
Determines the format of field values in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_LIST_CMDBC_ISRetrieves configuration items (CIs) from the ServiceNow CMDB using the base cmdb_ci class. Use this action when you need to query all configuration items from the CMDB, regardless of their specific type (servers, computers, databases, applications, etc.). This endpoint queries the base cmdb_ci class which contains all CIs. Supports filtering via sysparm_query and pagination via sysparm_limit and sysparm_offset.

Input Parameters

integer
Maximum number of configuration item records to return. Use pagination for larger result sets.
string
Encoded query to filter configuration items. Syntax: <col_name><operator><value>. Operators: ’=’ (exact match), ’!=’ (not equal), ’^’ (AND), ‘^OR’ (OR), LIKE, STARTSWITH, ENDSWITH. Example: operational_status=1^environment=Production
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,name,ip_address,operational_status’
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to paginate through results.
string
Determines the format of field values in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_LIST_CMDB_REL_TYPESRetrieves CMDB relationship types from the ServiceNow cmdb_rel_type table using the Table API. Use this action when you need to discover what types of relationships are defined between Configuration Items (CIs) in the CMDB. Common relationship types include ‘Runs on’, ‘Contains’, ‘Depends on’, ‘Hosted on’, and ‘Connects to’. This is useful for understanding the relationship schema before creating or querying CI relationships. Supports filtering via sysparm_query, pagination via sysparm_limit and sysparm_offset, field selection via sysparm_fields, and display value formatting via sysparm_display_value.

Input Parameters

integer
Maximum number of relationship type records to return. Use pagination for larger result sets.
string
Encoded query to filter relationship types. Syntax: <col_name><operator><value>. Operators: ’=’ (exact match), ’!=’ (not equal), ’^’ (AND), ‘^OR’ (OR), LIKE, STARTSWITH, ENDSWITH. Example: active=true^nameLIKEserver
string
Comma-separated list of fields to return in the response. Invalid field names are silently ignored. Example: ‘sys_id,name,child_class_name,parent_class_name’
integer
Starting record offset for pagination. Set to sysparm_offset + sysparm_limit to paginate through results.
string
Determines the format of field values in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_LIST_SERVICE_CATALOG_CATALOGSRetrieves a list of ServiceNow Service Catalog catalogs to which the user has access. Use this action when you need to fetch available service catalogs from ServiceNow, such as displaying available catalogs to users or filtering catalogs by name or description.

Input Parameters

string
Search text to filter catalogs by title or description
integer
Maximum number of catalogs to return. Defaults to 25 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_REFRESH_IMPACTED_SERVICESRefreshes and repopulates the impacted services/configuration items for a change request in ServiceNow using the Change Management REST API. Use this action when you need to recalculate and update the list of impacted services or configuration items for a change request. This is commonly used when: - The change request’s scope has changed - Configuration items need to be re-evaluated for impact - A new CI is added to the change and its impact needs to be computed Note: This action triggers a refresh of the impacted services based on the change request’s current configuration items and may modify the associated services.

Input Parameters

string
required
The unique system ID (sys_id) of the change request for which to refresh impacted services. This is a 32-character hexadecimal string that uniquely identifies the change request record. Example: ‘46e9b4afa9fe198101026e122b85f442’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_RETRIEVE_SN_CICD_UPDATE_SETRetrieves an update set with a given sys_id from the ServiceNow CICD (Continuous Integration/Continuous Delivery) plugin. Use this action when you need to retrieve an update set from the CICD plugin to access its contents, including remote updates and application details. This operation is typically used as a preliminary step before deploying or reviewing update set changes through the CICD pipeline. The action requires the sys_id of an existing update set that is available in the CICD system. After successful retrieval, the update set details including its state, application info, and remote updates will be returned.

Input Parameters

string
required
The sys_id of the update set to retrieve from the CICD plugin. This is the unique system identifier assigned to the update set.
string
The sys_id of the update source. Either update_source_id or update_source_instance_id is required.
string
The sys_id of the update source instance. Either update_source_id or update_source_instance_id is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_SCHEDULE_CHANGE_FIRST_AVAILABLEUpdates the planned start and end times of a ServiceNow change request to the first available schedule slot. Use this action when you need to automatically schedule a change request at the earliest available time slot based on the configured calendar and availability. This is useful for finding optimal scheduling windows when the specific timing is less important than scheduling as soon as possible. This action sends a PATCH request to the Change Management API endpoint, which automatically calculates and assigns the first available time slot for the change request. Note: The change request must exist and be in a schedulable state (typically ‘Open’ or ‘Approved’). The user must have appropriate permissions to modify the change request schedule.

Input Parameters

string
required
The unique system ID (sys_id) of the change request to schedule. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘46e9b4afa9fe198101026e122b85f442’. The change request must exist and be in a schedulable state.
integer
The expected duration of the change request in seconds. This is used to find the first available time slot that can accommodate the change. Default is 3600 seconds (1 hour). Minimum recommended is 300 seconds (5 minutes).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_CMDB_CSDM_APP_SERVICE_POPULATE_SERVICEPopulates an Application Service with CI (Configuration Item) relationships based on the CSDM (Common Service Data Model) model. Use this action when you need to automatically discover and populate the CIs (Configuration Items) and their relationships that belong to an application service in ServiceNow’s CMDB. This endpoint has been deprecated by ServiceNow. Consider using alternative approaches for CI population.

Input Parameters

string
required
The sys_id of the Application Service to populate with CI relationships. This is a required path parameter that uniquely identifies the application service record. Example: ‘17c04876833bf210dd2dc2dfeeaad3ee’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_CMDBCSDM_APP_SERVICE_SERVICE_DETAILSUpdates the service details for a specific application service in the CMDB CSDM (Common Service Data Model). Use this action when you need to modify the metadata, ownership, tier classification, or operational details of an application service in ServiceNow’s Configuration Management Database. This endpoint specifically updates the service_details attributes of the application service identified by its sys_id. This is an update (PUT) operation, so the provided fields will be set on the record. Fields not included in the request will retain their current values unless otherwise specified by the API. Common use cases: Updating application service ownership, changing tier or environment classifications, modifying criticality levels, or updating operational status.

Input Parameters

string
The display name of the application service. This is the human-readable name used to identify the service. Example: ‘Payment Processing Service’
string
The tier classification of the application service. Valid values: ‘1’ = Prescription, ‘2’ = Billing, ‘3’ = Monitoring, ‘4’ = Custom Application Services. Use the numeric string value corresponding to the desired tier.
string
The criticality level of the application service for business operations. Valid values: ‘1’ = High, ‘2’ = Medium, ‘3’ = Low. Use the numeric string value corresponding to the criticality level.
string
A detailed description of the application service explaining its purpose, functionality, and business value. Example: ‘Handles all payment processing including credit cards and ACH transfers’
string
The deployment environment for the application service. Valid values: ‘1’ = Development, ‘2’ = Test, ‘3’ = Production, ‘4’ = Staging. Use the numeric string value corresponding to the environment.
string
The sys_id of the team responsible for owning and maintaining the application service. Reference to sn_orgstructure_team table. Example: ‘xyz987654321fedcba9876543210zyxw’
string
The sys_id of the primary owner/person responsible for this application service. Reference to sys_user table. Example: ‘usr1234567890abcdef1234567890ab’
string
required
The unique system ID (sys_id) of the application service record to update. This is a 32-character hexadecimal string that identifies the specific application service in the cmdb_ci_appl_service table. Example: ‘abc1234567890abcdef1234567890ab’
string
The sys_id of the secondary/backup owner for this application service. Reference to sys_user table. Example: ‘usr987654321fedcba9876543210zyxw’
string
The current operational status of the application service. Typical values: ‘1’ = Operational, ‘2’ = Non-Operational, ‘3’ = Decommissioned, ‘7’ = Under Maintenance. Example: ‘1’
string
The sys_id of the application that this service supports. Reference to cmdb_ci_appl table. Example: ‘app1234567890abcdef1234567890ab’
string
Additional business criticality designation or notes. Can include details about why the service is critical and any associated SLAs. Example: ‘Mission critical - 99.99% uptime required’
string
The sys_id of the parent business service that owns this application service. Reference to cmdb_ci_service table. Example: ‘svc1234567890abcdef1234567890ab’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_CMDB_INSTANCE_BY_IDUpdates an existing configuration item (CI) record in the ServiceNow CMDB by its sys_id. Use this action when you need to modify attributes of a specific configuration item in the Configuration Management Database. This action sends a PUT request to the CMDB Instance API endpoint, replacing the specified attributes of the CI record. Note: The classname and sys_id are required path parameters. Only include the attributes you want to update in the request. This action performs a full update operation - fields not included in the request will retain their current values unless the API enforces specific default behavior. Common use cases: Updating CI operational status, changing ownership, modifying location information, updating IP addresses, changing assignment groups, or updating custom CMDB fields.

Input Parameters

string
required
Required. The entity that is updating this information — must be one of the choice values in the discovery_source field of the cmdb_ci table (e.g. ‘ServiceNow’, ‘ImportSet’, ‘ManualStagingTable’). Query the choice list via GET /api/now/table/sys_choice?sysparm_query=name=cmdb_ci^element=discovery_source to see valid values on this instance.
string
required
The unique system ID (sys_id) of the configuration item record to update. This is a 32-character hexadecimal string that uniquely identifies the CI. Example: ‘1234567890abcdef1234567890abcdef’
string
required
The name of the CMDB class (table) that the configuration item belongs to. This is a required path parameter. Common class names include: cmdb_ci (generic CI), cmdb_ci_server, cmdb_ci_database, cmdb_ci_network_adapter, cmdb_ci_ip_switch, cmdb_ci_lb, cmdb_ci_storage_device, cmdb_ciPrinter, cmdb_ci_appl, etc. Example: ‘cmdb_ci’ or ‘cmdb_ci_server’
object
A dictionary of CI attribute name-value pairs to update. These are the field names and values specific to the CMDB class. Common attributes include: name, short_description, description, serial_number, ip_address, mac_address, manufacturer, model_number, install_status, operational_status, owned_by, assigned_to, assignment_group, location, etc. Example: {‘name’: ‘Production Web Server’, ‘operational_status’: ‘1’}
object
Additional CMDB attributes to update that are not explicitly listed above. Use this for custom fields (prefixed with u_) or less common fields. Example: {‘u_custom_field’: ‘value’, ‘u_environment’: ‘production’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_CMDB_INSTANCE_BY_ID2Updates a specific ServiceNow CMDB configuration item by class and sys_id using the Table API. It sends the supplied attributes, including supported custom fields, in a PATCH request.

Input Parameters

string
Cost or price of the configuration item. Example: ‘15000.00’
string
Fully qualified domain name of the configuration item. Example: ‘web-server-prod-01.example.com’
string
Display name of the configuration item. Example: ‘web-server-prod-01’
string
required
The 32-character hexadecimal sys_id of the CMDB instance to update. This uniquely identifies the specific configuration item record. Example: ‘00a96c0d3790200044e0bfc8bcbe5db4’
string
Sys_id of the company that owns or is associated with this configuration item.
string
Physical location or data center of the configuration item. Example: ‘NYC-DC-1’, ‘EU-West-1’
string
required
The CMDB table class name that identifies the type of configuration item (CI) to update. Common values include ‘cmdb_ci’ (generic CI), ‘cmdb_ci_server’, ‘cmdb_ci_database’, ‘cmdb_ci_appl’, ‘cmdb_ci_service’, ‘cmdb_ci_network_device’, ‘cmdb_ci_hardware’, etc. Example: ‘cmdb_ci’
string
Hostname of the configuration item. Example: ‘web-server-prod-01’
string
Primary IP address of the configuration item. Example: ‘192.168.1.100’
string
Sys_id of the user or group that manages this configuration item.
string
Detailed description of the configuration item explaining its purpose and functionality.
string
Environment type for the configuration item. Common values: ‘Development’, ‘Test’, ‘Production’, ‘Staging’, ‘QA’. Example: ‘Production’
string
Manufacturer or vendor of the configuration item. Example: ‘Dell Inc.’, ‘Cisco Systems’
string
Model number of the configuration item. Example: ‘PowerEdge R740’, ‘UCS-B200-M4’
string
Sys_id of the user or group that provides support for this configuration item.
string
Date the configuration item was purchased (format: YYYY-MM-DD). Example: ‘2024-01-15’
string
Serial number assigned by the manufacturer. Example: ‘ABC123XYZ’
string
Installation status of the configuration item. Common values: ‘1’ = Installed, ‘2’ = On Order, ‘3’ = On Maintenance, ‘4’ = Stocked, ‘6’ = In Service, ‘7’ = Retired. Example: ‘1’
string
Sys_id of the assignment group responsible for this configuration item.
string
Brief summary or title of the configuration item. Example: ‘Production web server for app-1’
string
Operational status of the configuration item. Common values: ‘1’ = Operational, ‘2’ = Non-Operational, ‘3’ = Decommissioned, ‘7’ = Under Maintenance. Example: ‘1’
string
Warranty expiration date for the configuration item (format: YYYY-MM-DD). Example: ‘2027-01-15’
object
Additional CMDB instance fields to update that are not explicitly listed above. Use this for custom fields (prefixed with u_) or less common fields supported by the target class. Example: {‘u_custom_field’: ‘value’, ‘u_environment_tier’: ‘tier-3’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_CONVERSATION_MEMBER_DROPDrops an agent from a conversation in ServiceNow using the Conversation Member API. Use this action when you need to remove an agent or user from an active conversation. This operation requires the wa_integration_user role. The member will be immediately removed from the conversation and will no longer receive messages or events for it. This action is irreversible — once a member is dropped from a conversation, they cannot be automatically restored through this API and would need to be re-added manually.

Input Parameters

string
required
The unique identifier of the user/agent to drop from the conversation. This is a path parameter that identifies the conversation member to remove. The user must be currently assigned to a conversation for this operation to succeed.
string
The sys_id of the conversation to drop the member from. If not provided, the API will attempt to drop the member from the default conversation. This is recommended if the user is a member of multiple conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_INCIDENT_BY_IDUpdates an existing incident in ServiceNow identified by its sys_id using the Table API. Use this action when you need to modify an existing incident, such as updating its state, changing assignments, adding notes, updating priority, or resolving/closing the incident. Only the fields provided in the request will be updated; all other fields retain their current values. Note: This action performs a PUT (replace) operation. Only include the fields you want to update. This is a destructive operation in that it modifies data, but the changes can be reverted by calling this action again with corrected values.

Input Parameters

string
Current state of the incident. Common values: ‘1’=New, ‘2’=In Progress, ‘3’=On Hold, ‘4’=Resolved, ‘5’=Closed, ‘6’=Cancelled. Use the numeric string value corresponding to the desired state.
string
Boolean indicating whether the incident is active. Set to ‘true’ to activate or ‘false’ to deactivate.
string
Impact level of the incident (business criticality). Typical values: ‘1’=High, ‘2’=Medium, ‘3’=Low. Use the numeric string value corresponding to the impact level.
string
required
The unique system ID (sys_id) of the incident to update. This is a 32-character hexadecimal string that uniquely identifies the incident. Example: ‘1c832706732023002728660c4cf6a7b9’
string
The sys_id of the Configuration Item (CI) associated with the incident. Reference to cmdb_ci table. Example: ‘f9e9c33dc61122760072455df62663d2’
string
Urgency level of the incident (business criticality based on business needs). Typical values: ‘1’=High, ‘2’=Medium, ‘3’=Low. Use the numeric string value corresponding to the urgency level.
string
Category or classification of the incident. Examples: ‘network’, ‘hardware’, ‘software’, ‘database’. Values must match valid categories defined in your ServiceNow instance.
string
Additional comments or notes on the incident (visible to end users). Example: ‘Updated user on status of the incident’
string
Expected resolution date/time from assigned user. Format: ISO 8601 datetime string or YYYY-MM-DD HH:MM:SS. Example: ‘2024-12-01 17:00:00’
string
The sys_id of the location where the caller or service is located. Reference to cmn_location table. Example: ‘abcdef1234567890abcdef1234567890’
string
Boolean indicating whether the SLA was met (true/false as string). Example: ‘true’
string
Priority level of the incident. Typical values: ‘1’=Critical, ‘2’=High, ‘3’=Medium, ‘4’=Low, ‘5’=Planning. Use the numeric string value corresponding to the priority.
string
The sys_id of the person who reported the incident. Reference to sys_user table. Example: ‘681ccaf9c0a8016400b98a4e52c54f82’
string
Timestamp when the incident was closed. Format: ISO 8601 datetime string or YYYY-MM-DD HH:MM:SS. Example: ‘2024-12-01 15:00:00’
string
The sys_id of the user who closed the incident. Reference to sys_user table. Example: ‘681ccaf9c0a8016400b98a4e52c54f82’
string
Boolean indicating whether the incident is linked to a knowledge base article (true/false as string). Example: ‘false’
string
Resolution code when closing the incident. Stock examples: ‘Duplicate’, ‘Resolved by change’, ‘Workaround provided’, ‘Solution provided’. Values must match valid close codes defined in your ServiceNow instance.
string
Escalation status of the incident. Typical values: ‘normal’, ‘escalated’. Values must match valid escalation values defined in your ServiceNow instance.
string
Sys_id of the related problem record, if one exists. Reference to problem table. Example: ‘c9e9c33dc61122760072455df62663d2’
string
Internal work notes on the incident (not visible to end users). Example: ‘Checked logs and found service restart resolved the issue’
string
The sys_id of the user assigned to work on the incident. Reference to sys_user table. Example: ‘681ccaf9c0a8016400b98a4e52c54f82’
string
Notes added when closing the incident. Example: ‘Issue resolved by restarting the email service’
string
Detailed description of the incident. Example: ‘User unable to access email after password reset’
string
Reason the incident is on hold. Example: ‘Waiting for user feedback’
string
Timestamp when the incident was resolved. Format: ISO 8601 datetime string or YYYY-MM-DD HH:MM:SS. Example: ‘2024-12-01 14:30:00’
string
The sys_id of the user who resolved the incident. Reference to sys_user table. Example: ‘681ccaf9c0a8016400b98a4e52c54f82’
string
Subcategory of the incident. Must correspond to a valid subcategory for the selected category. Example: ‘email’ under ‘software’
string
Action to take upon rejection. Example: ‘cancel’
string
Method by which the incident was reported. Examples: ‘phone’, ‘email’, ‘self-service’, ‘walk-in’. Values must match valid contact types defined in your ServiceNow instance.
string
Action to take upon approval. Example: ‘proceed’
string
Correlation ID for linking related incidents or external references. Example: ‘EXT-12345’
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state’). Invalid fields are ignored. If not specified, all fields are returned.
string
Sys_id of the parent incident (can be used to collect incidents for the same root issue). Reference to incident table. Example: ‘a9e9c33dc61122760072455df62663d2’
string
The sys_id of the group assigned to the incident. Reference to sys_user_group table. Example: ‘287e8906c61122730024e53cf3104b26’
string
The sys_id of the business service affected by the incident. Reference to service_offering or business service table. Example: ‘b1e9c33dc61122760072455df62663d2’
string
Brief summary or title of the incident. Example: ‘Cannot access email system’
string
Display text for the correlation ID. Example: ‘External Ticket #12345’
boolean
Determines the type of data returned in the response. false: Returns actual database values (sys_ids for references, numeric values for choices). true: Returns display values (names for references, text labels for choices). all: Returns both display and actual values.
boolean
Set to true if providing display values (e.g., user names) instead of sys_ids in request fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response. Recommended to set to true to reduce response size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_INCIDENT_BY_ID2Updates a ServiceNow incident by sys_id using the Table API. Supports selected fields including state, assignment, work notes, priority, urgency, close notes and resolved time.

Input Parameters

string ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9")
Incident state values in ServiceNow
string
Impact level of the incident (1=High, 2=Medium, 3=Low). Indicates the effect on the business or users.
string
required
The unique system ID (sys_id) of the incident to update. This is a 32-character hexadecimal string that uniquely identifies the incident record. Example: ‘46b9490da9fe1981003c938dab89bda3’
string
Urgency level of the incident (1=High, 2=Medium, 3=Low). Indicates how quickly a response is needed.
string
Category or classification of the incident (e.g., ‘network’, ‘hardware’, ‘software’, ‘database’).
string ("1" | "2" | "3" | "4" | "5")
Incident priority values in ServiceNow
string
Sys_id of the user who reported the incident.
string
Internal work notes visible only to support staff (not visible to end users). Use for documenting investigation progress, actions taken, and resolution steps.
string
Sys_id of the user assigned to handle the incident. Example: ‘usr789xyz012abc345def678ghi901’
string
Notes added when closing the incident, typically explaining the resolution.
string
Detailed description of the incident, including steps to reproduce, error messages, and any relevant context. Example: ‘Users in Building A are unable to access the internal network since 9am’
string
Timestamp when the incident was resolved (format: YYYY-MM-DD HH:MM:SS).
string
Subcategory of the incident (e.g., ‘router’, ‘firewall’, ‘wifi’).
string
Method of contact (e.g., ‘phone’, ‘email’, ‘self-service’, ‘chat’).
string ("desktop" | "mobile" | "both")
UI view options for ServiceNow API
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state’). Invalid fields are ignored. If not specified, all fields are returned.
string
Sys_id of the group assigned to the incident. Example: ‘grp456def789ghi012jkl345mno678’
string
Brief summary or title of the incident. Required when creating a new incident. This should be a concise description of the issue visible to end users. Example: ‘Network connectivity issue in Building A’
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
boolean
Set to true if providing display values (e.g., user names) instead of sys_ids in the request body for reference fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response. Recommended to set to true to reduce response size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_OPENFRAME_VOICE_INTERACTIONUpdates an existing voice interaction record in ServiceNow OpenFrame. Use this action when you need to modify an existing voice interaction record, such as updating its status, changing assignment, adding notes, or resolving the interaction. This action sends a PATCH request to the OpenFrame voice-interaction API, allowing partial updates of the record fields. Note: Only include the fields you want to update in the request. Fields not included will retain their current values.

Input Parameters

string
Internal notes or comments about the voice interaction.
string
Current state or status of the voice interaction (e.g., ‘open’, ‘in_progress’, ‘closed’).
string
Priority level of the voice interaction (e.g., ‘1’ for critical, ‘2’ for high, ‘3’ for normal, ‘4’ for low).
string
sys_id of the user who initiated the voice interaction.
string
sys_id of the user assigned to handle the voice interaction.
string
Detailed description of the voice interaction.
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state’).
string
Code indicating how the interaction was resolved (e.g., ‘resolved’, ‘escalated’, ‘transferred’).
string
sys_id of the group assigned to handle the voice interaction.
string
Notes documenting the resolution of the voice interaction.
string
A brief summary or title describing the voice interaction.
string
required
The unique system ID (sys_id) of the voice interaction record to update. This is a path parameter.
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
boolean
Set to true if providing display values instead of sys_ids for reference fields.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_SERVICECATALOG_CARTUpdates an existing item in the ServiceNow Service Portal shopping cart. Use this action when you need to modify the quantity or variables of a cart item in the Service Catalog before checking out. This action sends a PUT request to the Service Catalog cart API endpoint, updating the specified cart item. Use when you need to change the quantity of an item in a user’s Service Portal shopping cart or update catalog item variables. The cart_item_id is required, and at least one of sysparm_quantity or variables should be provided.

Input Parameters

object
A dictionary of catalog item variable name-value string pairs to update. These are the variables associated with the catalog item. Example: {‘u_department’: ‘IT’, ‘u_justification’: ‘New laptop needed’}
string
required
The unique system ID (sys_id) of the cart item to update in the current shopping cart. This is a 32-character hexadecimal string that uniquely identifies the cart item. Example: ‘da46c07e83fbf210dd2dc2dfeeaad346’. The cart item must exist in the current user’s cart.
integer
The new quantity for the cart item. Must be a positive integer (minimum 1). If not provided or set to null, the quantity remains unchanged. Example: 3

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_SERVICECATALOG_ITEMS_SUBMIT_GUIDESubmits an order guide in ServiceNow’s Service Catalog with the specified variable values. Use this action when a user needs to submit an order guide in ServiceNow’s Service Catalog, providing variable values for the items within the order guide. The action retrieves the configured contents of the order guide with the submitted variable values and calculates pricing totals. This is commonly used to preview and submit order guides that contain pre-configured sets of catalog items (e.g., laptop requests, software bundles). The action sends a PUT request with the order guide sys_id and variable values, and returns the order guide items with calculated pricing information. Note: This action is idempotent - submitting the same order guide multiple times with the same variables will return the same calculated values.

Input Parameters

string
required
The unique system ID (sys_id) of the order guide to submit. This is a 32-character hexadecimal string that uniquely identifies the order guide item. Example: ‘25110912372211003e7d40ed9dbe5dd6’. The order guide must be active and available in the Service Catalog.
object
Variable values for the order guide submission. Keys are the variable names/IDs and values are the corresponding values to set. The required variables depend on the specific order guide configuration. Common variable types include text inputs, checkboxes, dropdowns, and reference fields. Example: {‘requested_for’: ‘user@example.com’, ‘justification’: ‘New equipment needed’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_SN_CHG_REST_CHANGEUpdates an existing change request in ServiceNow using the Change Management REST API. Use this action when you need to modify an existing change request, such as updating its state, changing assignments, adding notes, modifying dates, or updating the implementation plan. This action sends a PATCH request to the Change Management API, allowing partial updates of the record fields. Note: Only include the fields you want to update in the request. Fields not included will retain their current values. This is a destructive operation in that it modifies data, but the changes can be reverted by calling this action again with corrected values.

Input Parameters

string
Risk assessment of the change request (e.g., 1=High, 2=Medium, 3=Low)
string
Current phase of the change request lifecycle (e.g., planning, assessment, authorization, implementation, closure)
string
Current state of the change request. Common values: -7=Cancelled, -6=Rejected, -5=Skipped, -4=Closed Incomplete, -3=Closed Complete, -2=Closed Skipped, -1=Closed Cancelled, 0=Pending, 1=In Progress, 2=Open, 3=Approved, 4=Review, 5=Scheduled, 6=Implemented, 7=Evaluated
string
Impact level of the change request (e.g., 1=High, 2=Medium, 3=Low)
string
required
The unique system ID (sys_id) of the change request to update. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘46e9b4afa9fe198101026e122b85f442’
string
Category or classification of the change request
string
Priority of the change request (e.g., 1=Critical, 2=High, 3=Medium, 4=Low)
string
Test plan for the change
string
Internal work notes (not visible to end users)
string
Sys_id of the user assigned to implement the change
string
Notes added when closing the change request
string
Full description of the change request
string
Subcategory of the change request
string
Sys_id of the user who requested the change
string
Business justification for the change
string
Reason the change is on hold
string
Sys_id of the group assigned to the change
string
Planned end date and time of the change (format: YYYY-MM-DD HH:MM:SS)
string
Brief summary or title of the change request
string
Planned start date and time of the change (format: YYYY-MM-DD HH:MM:SS)
string
Implementation plan details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_SN_CHG_REST_CHANGE_EMERGENCYUpdates an existing emergency change request by sys_id using the ServiceNow Change Management API. It sends a partial update for supported fields such as description, assignment, priority, implementation plan, and schedule.

Input Parameters

string
Risk level of the emergency change request. Valid values: ‘low’, ‘medium’, ‘high’, ‘critical’
string
Current phase of the emergency change request workflow.
string
Current state of the emergency change request. Valid values: -5=Cancelled, -4=On hold, -3=Rejected, -2=Pending, -1=Draft, 1=Initiating, 2=Pending, 3=Open, 4=In Progress, 5=Under Review, 6=Scheduled, 7=Implemented, 8=Verified, 9=Closed
string
Impact level of the emergency change request. Valid values: 1=High, 2=Medium, 3=Low
string
Reason for the emergency change request or its current state.
string
required
The unique system ID (sys_id) of the emergency change request to update. This is a 32-character hexadecimal string that uniquely identifies the emergency change request. Example: ‘d53e72ec73d423002728660c4cf6a78d’
string
Scheduled CAB (Change Advisory Board) date in YYYY-MM-DD format.
string
Category classification of the emergency change request.
string
Comments visible to end users.
string
Priority level of the emergency change request. Valid values: 1=Critical, 2=High, 3=Moderate, 4=Low, 5=Planning
string
Test plan for validating the emergency change implementation.
string
Internal work notes not visible to end users.
string
sys_id of the user assigned to handle the emergency change request. Reference to sys_user table.
string
Notes added when closing the emergency change request.
string
Detailed description of the emergency change request. Use this to provide comprehensive details about the change, its purpose, and expected outcomes.
string
Subcategory classification of the emergency change request.
string
Expected end date and time of the emergency change. Format: YYYY-MM-DD HH:MM:SS
string
Business justification for the emergency change request.
string
Plan for rolling back the change if issues arise.
string
Expected start date and time of the emergency change. Format: YYYY-MM-DD HH:MM:SS
string
Reason for placing the emergency change request on hold.
string
sys_id of the group assigned to handle the emergency change request. Reference to sys_user_group table.
string
Brief summary or title of the emergency change request. This field provides a quick overview of what the emergency change is about.
string
CAB recommendation for the emergency change.
string
Detailed implementation steps for the emergency change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_SN_CHG_REST_CHANGE_NORMALUpdates a normal change request identified by its sys_id using the ServiceNow Change Management REST API. Use this action when you need to modify the details of an existing normal change request, such as updating its description, changing its state or priority, reassigning it to a different user or group, or updating schedule dates. Only the fields provided in the request will be updated; all other fields retain their current values. This is a PATCH operation — it performs a partial update. Only include the fields you want to change.

Input Parameters

string
Risk level of the change request. Typical values: ‘low’, ‘medium’, ‘high’, ‘critical’. Use lowercase string values as defined in your ServiceNow instance.
string
Current phase of the change request workflow. Typical values: ‘Draft’, ‘Assessment’, ‘Authorization’, ‘Scheduled’, ‘Implementation’, ‘Post-Implementation’, ‘Closed’. Use the exact phase names as defined in your ServiceNow instance.
string
Current state of the change request. Common values: ‘-5’=Cancelled, ‘-4’=On hold, ‘-3’=Rejected, ‘-2’=Pending, ‘-1’=Draft, ‘1’=Initiating, ‘2’=Pending, ‘3’=Open, ‘4’=In Progress, ‘5’=Under Review, ‘6’=Scheduled, ‘7’=Implemented, ‘8’=Verified, ‘9’=Closed. Use the numeric string value corresponding to the desired state.
string
Boolean indicating whether the change request is active. Set to ‘true’ to activate or ‘false’ to deactivate.
string
Impact level of the change request. Typical values: ‘1’=High, ‘2’=Medium, ‘3’=Low. Use the numeric string value corresponding to the impact level.
string
Reason for the change. Example: ‘End of life for legacy system component’
string
required
The unique system ID (sys_id) of the normal change request to update. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘a9e9c33dc61122760072455df62663d2’
string
Vendor associated with the change request. Example: ‘Acme Corp’
string
The sys_id of the Configuration Item (CI) associated with the change. Reference to cmdb_ci table. Example: ‘f9e9c33dc61122760072455df62663d2’
string
Company associated with the change request. Reference to core_company table via sys_id. Example: ‘1234567890abcdef1234567890abcdef’
string
CAB (Change Advisory Board) meeting date. Format: ISO 8601 datetime string. Example: ‘2024-11-25 10:00:00’
string
Category or classification of the change request. Examples: ‘Network’, ‘Hardware’, ‘Software’, ‘Application’. Values must match valid categories defined in your ServiceNow instance.
string
Comments visible to end users regarding the change. Example: ‘Scheduled maintenance window: 2024-12-01 02:00-04:00 UTC’
string
Contract associated with the change request. Example: ‘Vendor Support Agreement #12345’
string
Location associated with the change request. Reference to cmn_location table via sys_id. Example: ‘abcdef1234567890abcdef1234567890’
string
Priority level of the change request. Typical values: ‘1’=Critical, ‘2’=High, ‘3’=Standard, ‘4’=Low, ‘5’=Planning. Use the numeric string value corresponding to the priority.
string
The sys_id of the user who opened the change request. Reference to sys_user table. Example: ‘681ccaf9c0a8016400b98a4e52c54f82’
string
Test plan for validating the change. Example: ‘Verify service connectivity, check logs for errors’
string
Department associated with the change request. Reference to cmn_department table via sys_id. Example: ‘fedcba0987654321fedcba098765432’
string
Internal work notes for the change (not visible to end users). Example: ‘Contacted vendor support for additional guidance’
string
Names or sys_ids of users who approved the change (comma-separated for multiple). Example: ‘John Doe, Jane Smith’
string
The sys_id of the user assigned to implement the change. Reference to sys_user table. Example: ‘681ccaf9c0a8016400b98a4e52c54f82’
string
Notes added when closing the change request. Example: ‘Change completed successfully with no issues’
string
Detailed description of the change request. Example: ‘Requires updating firewall rules to allow traffic on port 443’
string
State within the current phase. Examples: ‘Complete’, ‘In Progress’, ‘Pending’, ‘Skipped’. Use the exact state names as defined in your ServiceNow instance.
string
Scheduled review date for the change. Format: ISO 8601 datetime string. Example: ‘2024-11-30 09:00:00’
string
Subcategory of the change request. Must correspond to a valid subcategory for the selected category. Example: ‘Firewall’ under ‘Network’
string
The sys_id of the user who requested the change. Reference to sys_user table. Example: ‘681ccaf9c0a8016400b98a4e52c54f82’
string
Business justification for the change. Example: ‘Required for compliance with new security policy’
string
Reason for placing the change request on hold. Example: ‘Waiting for approval from security team’
string
Actual end date and time when the change was completed. Format: ISO 8601 datetime string. Example: ‘2024-12-01 03:45:00’
string
The sys_id of the group assigned to the change. Reference to sys_user_group table. Example: ‘287e8906c61122730024e53cf3104b26’
string
Planned end date and time of the change. Format: ISO 8601 datetime string. Example: ‘2024-12-01 04:00:00’
string
The sys_id of the service offering related to the change. Reference to service_offering table. Example: ‘b1e9c33dc61122760072455df62663d2’
string
Actual start date and time when the change began. Format: ISO 8601 datetime string. Example: ‘2024-12-01 02:05:00’
string
Business duration in seconds (calculated based on business hours). Example: ‘7200’ for 2 hours
string
Calendar duration in seconds (total elapsed time). Example: ‘14400’ for 4 hours
string
Brief summary or title of the change request. Example: ‘Update network configuration for DC-2’
string
CAB recommendation for the change. Example: ‘Approved with conditions’
string
Planned start date and time of the change. Format: ISO 8601 datetime string. Example: ‘2024-12-01 02:00:00’
string
Implementation plan details describing how the change will be executed. Example: ‘Step 1: Backup current config. Step 2: Apply new config. Step 3: Verify.‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_SN_CHG_REST_CHANGE_STANDARDUpdates a standard change request in ServiceNow using its sys_id. Use this action when you need to modify an existing standard change request, such as updating its description, changing the assigned user or group, modifying dates, updating state or phase, or adding implementation and test plans. This is a PATCH operation that updates only the provided fields while preserving all other existing values on the record. This action uses the PATCH method, which means only fields included in the request will be modified. Fields not provided will retain their current values.

Input Parameters

string
Risk level of the standard change request. Valid values: ‘low’, ‘medium’, ‘high’, ‘critical’. Example: ‘low’
string
Current phase of the standard change request workflow. Example: ‘Requested’, ‘Approved’, ‘Scheduled’, ‘Implementation’, ‘Review’, ‘Closed’
string
Current state of the standard change request. Common values: -5=Cancelled, -4=On hold, -3=Rejected, -2=Pending, -1=Draft, 1=Initiating, 2=Pending, 3=Open, 4=In Progress, 5=Under Review, 6=Scheduled, 7=Implemented, 8=Verified, 9=Closed. Note: State transitions may require appropriate permissions and workflow conditions.
string
Boolean indicating if the standard change request is active. Use ‘true’ to activate or ‘false’ to deactivate. Example: ‘true’
string
Impact level of the standard change request. Typical values: 1=Critical, 2=High, 3=Medium, 4=Low. Example: ‘2’
string
Reason for the standard change request. Example: ‘Performance optimization required’
string
required
The unique system ID (sys_id) of the standard change request to update. This is a 32-character hexadecimal string that uniquely identifies the standard change request. Example: ‘543a39de47410200e90d87e8dee4908a’
string
Vendor associated with the standard change request. Example: ‘ACME Corporation’
string
The sys_id of the Configuration Item (CI) associated with the standard change request. Reference to cmdb_ci table. Example: ‘ci1234567890abcdef1234567890ab’
string
The sys_id of the company associated with the standard change request. Reference to core_company table. Example: ‘com1234567890abcdef1234567890ab’
string
Category classification of the standard change request. Must be a valid category defined in the change management configuration. Example: ‘Software’ or ‘Hardware’
string
Comments visible to end users about the standard change request. Example: ‘Maintenance window: 2AM-4AM UTC’
string
The sys_id of the location associated with the standard change request. Reference to cmn_location table. Example: ‘loc1234567890abcdef1234567890ab’
string
Priority level of the standard change request. Typical values: 1=Critical, 2=High, 3=Standard, 4=Low, 5=Planning. Example: ‘2’
string
Work end date and time for the standard change. Format: YYYY-MM-DD HH:MM:SS or ISO 8601 format. Example: ‘2024-12-15 04:00:00’
string
Purchase order number associated with the standard change request. Example: ‘PO-2024-12345’
string
Test plan for the standard change request describing how the change will be tested before and after implementation. Example: ‘Verify application starts successfully and database connections work’
string
Actual end date and time of the standard change. Format: YYYY-MM-DD HH:MM:SS or ISO 8601 format. Example: ‘2024-12-15 03:45:00’
string
The sys_id of the department associated with the standard change request. Reference to cmn_department table. Example: ‘dept1234567890abcdef1234567890ab’
string
Internal work notes for the standard change request (not visible to end users). Use this for technical details and progress updates. Example: ‘Applied config changes to all servers’
string
Work start date and time for the standard change. Format: YYYY-MM-DD HH:MM:SS or ISO 8601 format. Example: ‘2024-12-15 02:00:00’
string
The sys_id of the user to assign the standard change request to. Reference to sys_user table. Example: ‘usr1234567890abcdef1234567890ab’
string
Change plan details for the standard change request. Example: ‘Update configuration files and restart services’
string
Notes to add when closing the standard change request. Include any final comments, lessons learned, or completion status. Example: ‘Change completed successfully. No issues encountered.’
string
Detailed description of the standard change request explaining what needs to be changed and why. Example: ‘Update connection pooling settings in production database to improve performance’
string
State within the current phase of the workflow
string
Subcategory classification of the standard change request. Must be a valid subcategory within the selected category. Example: ‘Operating System’ or ‘Database’
string
Actual start date and time of the standard change. Format: YYYY-MM-DD HH:MM:SS or ISO 8601 format. Example: ‘2024-12-15 02:05:00’
string
Backout plan describing the procedure to back out of the standard change. Example: ‘Execute revert script and notify team’
string
Expected end date and time of the standard change. Format: YYYY-MM-DD HH:MM:SS or ISO 8601 format. Example: ‘2024-12-15 04:00:00’
string
The sys_id of the user who requested the standard change. Reference to sys_user table. Example: ‘usr987654321fedcba9876543210zyxw’
string
Business justification for the standard change request. Example: ‘Improve system performance and reduce downtime’
string
Rollback plan describing how to revert the standard change if issues occur. Example: ‘Restore from backup and restart previous version’
string
Expected start date and time of the standard change. Format: YYYY-MM-DD HH:MM:SS or ISO 8601 format. Example: ‘2024-12-15 02:00:00’
string
Reason for placing the standard change request on hold. Example: ‘Waiting for vendor approval’
string
Outcome of the standard change review. Example: ‘Success’, ‘Failed’, ‘Partial’
string
Comments from the standard change review. Example: ‘All tests passed successfully’
string
The sys_id of the group to assign the standard change request to. Reference to sys_user_group table. Example: ‘grp1234567890abcdef1234567890ab’
string
The sys_id of the service offering associated with the standard change request. Reference to service_offering table. Example: ‘svc1234567890abcdef1234567890ab’
string
Brief summary or title of the standard change request. Example: ‘Update database configuration for production servers’
string
CAB recommendation for the standard change. Example: ‘Approved’, ‘Rejected’, ‘Approved with conditions’
string
Implementation plan describing the steps to implement the standard change. Example: ‘1. Backup current config, 2. Apply new settings, 3. Restart service’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_SN_CHG_REST_CHANGE_TASKUpdates an existing change request task in ServiceNow using the Change Management REST API. Use this action when you need to modify an existing task associated with a change request, such as updating its status, changing assignment, adding work notes, or marking it complete. This action sends a PATCH request to the Change Management API, allowing partial updates of the task fields. Only include the fields you want to update in the request - fields not included will retain their current values. Note: The task must already exist within the specified change request. If the change request or task doesn’t exist, a 404 error will be returned.

Input Parameters

string
Current state of the task. Common values: -5=Cancelled, -4=On hold, -3=Rejected, -2=Pending, -1=Draft, 1=Open, 2=Work In Progress, 3=Pending, 4=Complete
string
Public comments on the task (visible to end users)
string
Priority level of the task (e.g., ‘1’ for critical, ‘2’ for high, ‘3’ for moderate, ‘4’ for low, ‘5’ for planning)
string
Actual end date and time when the task was completed (ISO 8601 format)
string
Internal work notes for the task (visible to IT staff only)
string
sys_id of the user assigned to the task
string
Notes added when closing the task
string
Full description of the task
string
required
The unique system ID (sys_id) of the task to update within the change request. This is a 32-character hexadecimal string that uniquely identifies the task. Example: ‘cd820c7a833bf210dd2dc2dfeeaad333’. The task must exist within the specified change request, or a 404 error will be returned.
string
Actual start date and time when the task began (ISO 8601 format)
string
Expected end date and time of the task (ISO 8601 format)
string
required
The unique system ID (sys_id) of the change request containing the task to update. This is a 32-character hexadecimal string that uniquely identifies the change request. Example: ‘46e9b4afa9fe198101026e122b85f442’. The change request must exist, or a 404 error will be returned.
string
Expected start date and time of the task (ISO 8601 format)
string
Reason the task is on hold
string
sys_id of the group assigned to the task
string
Brief summary or title of the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_SN_IND_TSM_SDWAN_TICKET_TROUBLETICKETUpdates an incident record by ID using the ServiceNow Table API. It sends the supplied trouble-ticket fields, such as state, assignment, notes, and resolution details, in a partial update.

Input Parameters

string
required
The unique identifier (sys_id or record ID) of the trouble ticket to update. This is a 32-character hexadecimal string that uniquely identifies the trouble ticket record. Example: ‘1c741bd70b2322007518478d83673af3’
string
Current state of the trouble ticket. Common values vary by workflow but typically include: ‘Open’, ‘In Progress’, ‘On Hold’, ‘Resolved’, ‘Closed’, ‘Cancelled’. The exact state values depend on your ServiceNow configuration.
string
Category or classification of the trouble ticket. Example categories: ‘Network’, ‘Hardware’, ‘Software’, ‘Security’. The exact categories depend on your ServiceNow configuration.
string
Priority level of the trouble ticket. Typical values: 1 = Critical (service down), 2 = High (major impact), 3 = Medium (moderate impact), 4 = Low (minor impact). The exact priority values depend on your ServiceNow configuration.
string
The resolution code for closing the trouble ticket. Common values: ‘Resolved’, ‘Closed/Resolved’, ‘Closed/Cancelled’, ‘Not Resolved’, ‘Escalated’. The exact values depend on your configuration.
string
Internal work notes about the trouble ticket. These notes are only visible to users with appropriate roles and are not visible to end users or customers. Use this for technical details and updates. Example: ‘Investigated the issue and identified root cause as faulty switch’
string
Sys_id of the user assigned to handle the trouble ticket. This is the 32-character hexadecimal string that identifies the user. Example: ‘usr789xyz012abc345def678ghi901’
string
Full detailed description of the trouble ticket, including symptoms, impact, and any relevant background information. Example: ‘Users unable to access the corporate network since 9 AM’
string
Subcategory of the trouble ticket for more specific classification. Example subcategories: ‘Firewall’, ‘Router’, ‘Switch’, ‘VPN’. The exact subcategories depend on your ServiceNow configuration.
string
Comma-separated list of fields to return in the response. Invalid fields are ignored. If not specified, all fields are returned. Example: ‘number,short_description,state,assigned_to’
string
Sys_id of the group assigned to handle the trouble ticket. This is the 32-character hexadecimal string that identifies the group. Example: ‘grp456def789ghi012jkl345mno678’
string
Notes documenting how the trouble ticket was resolved. These are typically added when closing the ticket and describe the solution. Example: ‘Replaced faulty switch and connectivity restored’
string
Brief summary or title of the trouble ticket. This describes the issue or request in a concise manner. Example: ‘Network connectivity issue in DC1’
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
Set to true to exclude Table API links for reference fields in the response. Use this to reduce response size when reference links are not needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_SN_IND_TSM_SDWAN_TROUBLETICKETUpdates a Case, Incident, Problem, or ChangeRequest record by sys_id using the ServiceNow Table API. It sends the supplied fields as a partial update, including state, assignments, notes, dates, and resolution details.

Input Parameters

string
required
The unique identifier of the trouble ticket to update. This can be the sys_id or the display number of the ticket. Example: ‘1’ or ‘CAS0010001’
string
Current state of the trouble ticket. Common values vary by ticket type but typically include: 1=New/Open, 2=In Progress, 3=On Hold, 4=Resolved, 5=Closed, 6=Cancelled. Use the numeric string value corresponding to the desired state.
string
Impact level of the trouble ticket. Typical values: 1=High, 2=Medium, 3=Low. Use the numeric string value corresponding to the impact level.
string
Sys_id of the Configuration Item associated with the trouble ticket
string
Urgency level of the trouble ticket. Typical values: 1=High, 2=Medium, 3=Low. Use the numeric string value corresponding to the urgency level.
string
Category or classification of the trouble ticket
string
Comments visible to end users regarding the trouble ticket
string
Priority of the trouble ticket. Typical values: 1=Critical, 2=High, 3=Moderate, 4=Low. Use the numeric string value corresponding to the priority level.
string
Sys_id of the user who reported the issue
string
Code indicating how the trouble ticket was resolved
string
Escalation status of the trouble ticket
string
Internal work notes for the trouble ticket (not visible to end users)
string
Sys_id of the user assigned to handle the trouble ticket
string
Notes added when closing the trouble ticket
string
Full description of the trouble ticket
string
Reason for placing the trouble ticket on hold
string
Timestamp when the trouble ticket was resolved (format: YYYY-MM-DD HH:MM:SS)
string
Sys_id of the user who resolved the trouble ticket
string
Subcategory of the trouble ticket
string ("Case" | "Incident" | "Problem" | "ChangeRequest")
required
The type of trouble ticket to update. Valid values: ‘Case’, ‘Incident’, ‘Problem’, ‘ChangeRequest’. Example: ‘Case’
string
Sys_id of the group assigned to the trouble ticket
string
Brief summary or title of the trouble ticket
string
Business resolution description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_TABLE_BY_IDUpdates an existing record in a specified ServiceNow table by its sys_id using the Table API. Use this action when you need to modify specific fields of an existing record, such as updating the short_description, changing the state, reassigning the record, adding close_notes, or modifying any other table field. Only the fields specified in record_data are updated — all other fields retain their current values. This action sends a PATCH request to the ServiceNow Table API. This action modifies data but the changes can be reverted by calling this action again with the corrected values. This is an idempotent operation — calling it multiple times with the same parameters produces the same result.

Input Parameters

string
required
The unique system ID (sys_id) of the record to update. This is a 32-character hexadecimal string. Example: ‘3877ccb6833ff210dd2dc2dfeeaad375’
string
required
The name of the table containing the record to update. Examples: ‘incident’, ‘problem’, ‘change_request’, ‘task’, ‘sys_user’.
object
Field-value pairs to update on the record. Only the specified fields are updated; all other fields retain their current values. For ‘incident’ table, common fields include: ‘short_description’, ‘description’, ‘urgency’ (1-3), ‘impact’ (1-3), ‘priority’, ‘assignment_group’, ‘assigned_to’, ‘category’, ‘state’, ‘close_notes’, ‘work_notes’. For reference fields (like ‘assigned_to’), use the sys_id of the referenced record, or set sysparm_input_display_value=true to use display values. Example: {‘short_description’: ‘Updated via API’, ‘urgency’: ‘2’, ‘impact’: ‘2’}
string ("desktop" | "mobile" | "both")
UI view that determines which fields are returned.
string
Comma-separated list of fields to return in the response. Invalid fields are ignored. If not specified, all fields are returned. Example: ‘number,short_description,state,assigned_to’
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
boolean
Set to true if providing display values (e.g., user names) instead of sys_ids in record_data for reference fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_TABLE_BY_ID2Updates an existing record in a specified ServiceNow table by sys_id using PUT and the provided field values. Response options can select fields and control display values.

Input Parameters

string
required
The unique system ID (sys_id) of the record to update. This is a 32-character hexadecimal string that uniquely identifies the record. Example: ‘1c741bd70b2322007518478d83673af3’
string
required
Name of the ServiceNow table to update the record in (e.g., ‘incident’, ‘problem’, ‘change_request’, ‘task’, ‘sys_user’). The table must exist in the ServiceNow instance and the user must have write permissions.
object
Field-value pairs to update in the record. This replaces the entire record with the provided data. For ‘incident’ table, common fields include: ‘short_description’, ‘description’, ‘urgency’ (1-3), ‘impact’ (1-3), ‘priority’, ‘assignment_group’, ‘assigned_to’, ‘category’, ‘state’. For reference fields (like ‘assignment_group’ or ‘assigned_to’), use the sys_id of the referenced record, or set sysparm_input_display_value=true to use display values. Example: {‘short_description’: ‘Updated via API’, ‘state’: ‘2’}
string ("desktop" | "mobile" | "both")
UI view options for ServiceNow table API
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state’). Invalid fields are ignored. If not specified, all fields are returned.
string ("true" | "false" | "all")
Display value options for ServiceNow table API responses
boolean
Set to true if providing display values (e.g., user names) instead of sys_ids in record_data for reference fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response. When false (default), reference fields include a ‘link’ property pointing to the API endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_TABLE_INCIDENTUpdates an existing ServiceNow incident by sys_id using the Table API. Supports selected fields including state, assignment, priority, urgency, work notes and closure details.

Input Parameters

string ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9")
Incident state values in ServiceNow
string
Impact level of the incident (1=High, 2=Medium, 3=Low). Indicates the effect on the business or users.
string
required
The unique system ID (sys_id) of the incident to update. This is a 32-character hexadecimal string that uniquely identifies the incident record. Example: ‘13e7c0fa833ff210dd2dc2dfeeaad3fc’
string
Urgency level of the incident (1=High, 2=Medium, 3=Low). Indicates how quickly a response is needed.
string
Category or classification of the incident (e.g., ‘network’, ‘hardware’, ‘software’, ‘database’).
string ("1" | "2" | "3" | "4" | "5")
Incident priority values in ServiceNow
string
Sys_id of the user who reported the incident.
string
Internal work notes visible only to support staff (not visible to end users). Use for documenting investigation progress, actions taken, and resolution steps.
string
Sys_id of the user assigned to handle the incident. Example: ‘usr789xyz012abc345def678ghi901’
string
Notes added when closing the incident, typically explaining the resolution.
string
Detailed description of the incident, including steps to reproduce, error messages, and any relevant context. Example: ‘Users in Building A are unable to access the internal network since 9am’
string
Timestamp when the incident was resolved (format: YYYY-MM-DD HH:MM:SS).
string
Subcategory of the incident (e.g., ‘router’, ‘firewall’, ‘wifi’).
string
Method of contact (e.g., ‘phone’, ‘email’, ‘self-service’, ‘chat’).
string ("desktop" | "mobile" | "both")
UI view to determine which fields are returned in the response. If not specified, returns fields from the default view.
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state’). Invalid fields are ignored. If not specified, all fields are returned.
string
Sys_id of the group assigned to the incident. Example: ‘grp456def789ghi012jkl345mno678’
string
Brief summary or title of the incident (visible to end users). This should be a concise description of the issue. Example: ‘Network connectivity issue in Building A’
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
boolean
Set to true if providing display values (e.g., user names) instead of sys_ids in the request body for reference fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response. Recommended to set to true to reduce response size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPDATE_TABLE_RECORDUpdates an existing record in a specified ServiceNow table using the Table API. Use this action when you need to modify an existing record in any ServiceNow table (e.g., incident, problem, change_request, task). Only the fields specified in record_data will be updated; all other fields retain their current values. This is a destructive operation in that it modifies data, but changes can be reverted by calling this action again with corrected values. Note: For the ServiceNow Table API, both PUT and PATCH methods function identically - only specified fields are updated.

Input Parameters

string
required
The unique system identifier (sys_id) of the record to update. This is a 32-character hexadecimal string.
string
required
The name of the table containing the record to update (e.g., ‘incident’, ‘problem’, ‘change_request’, ‘task’, ‘sys_user’).
object
required
Field-value pairs to update in the record. Only specified fields will be updated; fields not included will retain their current values. Available fields depend on the table schema. For ‘incident’ table, common updateable fields include: ‘short_description’, ‘description’, ‘urgency’, ‘impact’, ‘priority’, ‘assignment_group’, ‘assigned_to’, ‘category’, ‘state’, ‘work_notes’, ‘comments’. For reference fields (like ‘assignment_group’ or ‘assigned_to’), use the sys_id of the referenced record, or set sysparm_input_display_value=true to use display values instead. Example: {‘short_description’: ‘Updated via API’, ‘state’: ‘2’}
string ("desktop" | "mobile" | "both")
UI view to determine which fields are returned in the response. If not specified, returns fields from the default view.
string
Comma-separated list of fields to return in the response (e.g., ‘number,short_description,state’). Invalid fields are ignored. If not specified, all fields are returned.
string ("true" | "false" | "all")
Determines the type of data returned in the response. ‘false’: Returns actual database values (sys_ids for references, numeric values for choices). ‘true’: Returns display values (names for references, text labels for choices). ‘all’: Returns both display and actual values.
boolean
Set to true if providing display values (e.g., user names) instead of sys_ids in record_data for reference fields. When false (default), reference fields must contain sys_ids.
Set to true to exclude Table API links for reference fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICENOW_UPLOAD_ATTACHMENTUploads a file as an attachment to a specified record in ServiceNow. Use this action when you need to attach files to ServiceNow records (e.g., incidents, problems, change requests) using the raw binary upload endpoint (/api/now/v1/attachment/file). The file content is sent as raw binary data with the Content-Type header reflecting the file type. Common use cases: - Attach documents or screenshots to incident reports - Upload evidence files to problem records - Add files to change requests for documentation This action permanently modifies a live ServiceNow instance — the attachment cannot be recovered once deleted.

Input Parameters

string
Inline file content as a string. Use this OR ‘file_content’ field, not both. The content will be encoded as UTF-8 bytes for upload.
string
required
Name to give the attachment file (e.g., ‘report.pdf’, ‘screenshot.png’).
string
required
Name of the ServiceNow table to attach the file to (e.g., ‘incident’, ‘problem’, ‘change_request’).
string
MIME type of the content. Defaults to ‘text/plain’ if not specified. Only used when ‘content’ field is provided.
object
File content to upload. The file name should match the filename to use in ServiceNow. Use this OR ‘content’ field, not both.
string
required
Sys_id of the record in the table to attach the file to. This is the unique identifier of the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not