Add configuration item relations
Action ID:tools.servicenow.add_ci_relations
Add inbound and/or outbound relations to a configuration item with the CMDB Instance API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/cmdb-instance-api.html#cmdb-POST-instance-relation
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
CMDB class (table) name, e.g. cmdb_ci_linux_server, cmdb_ci_win_server, or cmdb_ci_appl.
string
required
Discovery source that is updating the CI. Must be a choice value of cmdb_ci.discovery_source, e.g. ServiceNow.
string
required
sys_id of the parent configuration item.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.array[object] | null
Inbound relations, each {“target”: “<ci sys_id>”, “type”: “<cmdb_rel_type sys_id>”}.Default:
null.array[object] | null
Outbound relations, each {“target”: “<ci sys_id>”, “type”: “<cmdb_rel_type sys_id>”}.Default:
null.Add incident comment
Action ID:tools.servicenow.add_incident_comment
Add a customer-visible comment (additional comments) to an incident.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-PATCH
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Comment text visible to the caller.
string
required
sys_id of the incident.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Add incident work note
Action ID:tools.servicenow.add_incident_work_note
Add an internal work note to an incident.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-PATCH
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the incident.
string
required
Internal work note text.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Add item to cart
Action ID:tools.servicenow.add_item_to_cart
Add a catalog item to the caller’s cart.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-POST-items-add_to_cart
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the catalog item.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Comma-separated sys_ids of additional users to order the item for.Default:
null.integer
Quantity of the item.Default:
1.string | null
sys_id of the user to order the item for.Default:
null.object | null
Form variable values keyed by variable name. Use get_catalog_item to list an item’s variables.Default:
null.Add record comment
Action ID:tools.servicenow.add_record_comment
Add a customer-visible comment to any task-based record, such as a problem, change request, requested item, catalog task, or security incident.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-PATCH
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Comment text.
string
required
sys_id of the record.
string
required
Table name, e.g. incident, problem, change_request, sc_req_item, sc_task, or sn_si_incident.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Add record work note
Action ID:tools.servicenow.add_record_work_note
Add an internal work note to any task-based record, such as a problem, change request, requested item, catalog task, or security incident.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-PATCH
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the record.
string
required
Table name, e.g. incident, problem, change_request, sc_req_item, sc_task, or sn_si_incident.
string
required
Work note text.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Assign incident
Action ID:tools.servicenow.assign_incident
Assign an incident to a group and/or user.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-PATCH
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the incident.
string | null
sys_id of the assignee (sys_user).Default:
null.string | null
sys_id of the assignment group (sys_user_group).Default:
null.string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.boolean | null
Set field values using display values instead of actual values.Default:
null.Close incident
Action ID:tools.servicenow.close_incident
Close an incident by setting state to 7 (Closed) with a resolution code and notes.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-PATCH
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Resolution code. Choices vary by instance; use get_choice_values with table incident and element close_code.
string
required
Resolution notes.
string
required
sys_id of the incident.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string
Target incident state. OOTB 7 is Closed.Default:
"7".Create case
Action ID:tools.servicenow.create_case
Create a Customer Service Management case with the Case API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/case-api.html#case-POST-case
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Brief summary of the case.
string | null
sys_id of the customer account (customer_account).Default:
null.string | null
sys_id of the assignee.Default:
null.string | null
sys_id of the assignment group.Default:
null.string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Case category.Default:
null.string | null
sys_id of the consumer, for B2C cases.Default:
null.string | null
sys_id of the customer contact.Default:
null.string | null
Channel the case was reported through, e.g. email, phone, web.Default:
null.string | null
Detailed description of the case.Default:
null.object | null
Additional case field values keyed by field name, e.g. {“u_custom_field”: “value”}.Default:
null.string | null
Priority: 1 (Critical), 2 (High), 3 (Moderate), 4 (Low).Default:
null.string | null
sys_id of the product (cmdb_model).Default:
null.Create configuration item
Action ID:tools.servicenow.create_ci
Create a configuration item in a CMDB class with the CMDB Instance API, applying identification and reconciliation rules.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/cmdb-instance-api.html#cmdb-POST-instance
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
object
required
CI attributes keyed by field name, e.g. {“name”: “web-01”, “ip_address”: “10.0.0.5”}.
string
required
CMDB class (table) name, e.g. cmdb_ci_linux_server, cmdb_ci_win_server, or cmdb_ci_appl.
string
required
Discovery source that is updating the CI. Must be a choice value of cmdb_ci.discovery_source, e.g. ServiceNow.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.array[object] | null
Inbound relations, each {“target”: “<ci sys_id>”, “type”: “<cmdb_rel_type sys_id>”}.Default:
null.array[object] | null
Outbound relations, each {“target”: “<ci sys_id>”, “type”: “<cmdb_rel_type sys_id>”}.Default:
null.Create incident
Action ID:tools.servicenow.create_incident
Create an incident with the Table API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-POST
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Brief summary of the incident.
string | null
sys_id of the assignee (sys_user).Default:
null.string | null
sys_id of the assignment group (sys_user_group).Default:
null.string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
sys_id (or display value with sysparm_input_display_value) of the user reporting the incident.Default:
null.string | null
Incident category, e.g. inquiry, software, hardware, network.Default:
null.string | null
sys_id of the affected configuration item (cmdb_ci).Default:
null.string | null
Channel the incident was reported through, e.g. email, phone, self-service.Default:
null.string | null
Detailed description of the incident.Default:
null.object | null
Additional incident field values keyed by field name, e.g. {“u_custom_field”: “value”}.Default:
null.string | null
Impact: 1 (High), 2 (Medium), 3 (Low).Default:
null.string | null
Incident subcategory.Default:
null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.boolean | null
Exclude Table API links for reference fields.Default:
null.string | null
Comma-separated list of fields to return.Default:
null.boolean | null
Set field values using display values instead of actual values.Default:
null.string | null
Urgency: 1 (High), 2 (Medium), 3 (Low).Default:
null.Create ServiceNow record
Action ID:tools.servicenow.create_record
Create a record in a ServiceNow table.
Reference: https://www.servicenow.com/docs/bundle/zurich-api-reference/page/build/applications/concept/api-rest.html
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Base API URL, e.g. https://example.service-now.com/api/now.
object
required
JSON payload for the new record.
string
required
ServiceNow table name, e.g. ‘incident’, ‘sys_user’.
object | null
Optional query parameters such as sysparm_display_value.Default:
null.Delete attachment
Action ID:tools.servicenow.delete_attachment
Delete an attachment with the Attachment API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_AttachmentAPI.html#attachment-DELETE
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the attachment.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Delete cart item
Action ID:tools.servicenow.delete_cart_item
Remove an item from the caller’s cart.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-DELETE-cart
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the cart item.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Delete configuration item relation
Action ID:tools.servicenow.delete_ci_relation
Delete a relation from a configuration item with the CMDB Instance API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/cmdb-instance-api.html#cmdb-DELETE-instance-relation
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
CMDB class (table) name, e.g. cmdb_ci_linux_server, cmdb_ci_win_server, or cmdb_ci_appl.
string
required
sys_id of the relation (cmdb_rel_ci).
string
required
sys_id of the configuration item.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Delete ServiceNow record
Action ID:tools.servicenow.delete_record
Delete a ServiceNow table record by sys_id.
Reference: https://www.servicenow.com/docs/bundle/zurich-api-reference/page/build/applications/concept/api-rest.html
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Base API URL, e.g. https://example.service-now.com/api/now.
string
required
Unique record identifier (sys_id).
string
required
ServiceNow table name, e.g. ‘incident’, ‘sys_user’.
object | null
Optional query parameters such as sysparm_display_value.Default:
null.Download attachment
Action ID:tools.servicenow.download_attachment
Download attachment content with the Attachment API. The file is returned base64-encoded in data.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_AttachmentAPI.html#attachment-GET-file
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the attachment.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Get attachment
Action ID:tools.servicenow.get_attachment
Get attachment metadata with the Attachment API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_AttachmentAPI.html#attachment-GET-sys_id
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the attachment.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Get cart
Action ID:tools.servicenow.get_cart
Get the contents of the caller’s cart.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-GET-cart
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Get case
Action ID:tools.servicenow.get_case
Get a Customer Service Management case by sys_id or case number with the Case API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/case-api.html#case-GET-case-id
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id or case number, e.g. CS0001001.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.Get case field values
Action ID:tools.servicenow.get_case_field_values
List valid values for a case field, such as priority or a reference field, with the Case API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/case-api.html#case-GET-case-field_values
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Case field name, e.g. priority, state, or account.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Value of the field this field depends on.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Encoded query used to filter the result set, e.g. active=true^priority=1^ORDERBYDESCsys_created_on.Default:
null.Get catalog item
Action ID:tools.servicenow.get_catalog_item
Get a catalog item or record producer, including its form variables.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-GET-items-sys_id
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the catalog item or record producer.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
UI view to return items for.Default:
null.Get choice values
Action ID:tools.servicenow.get_choice_values
List the active choice values for a choice field, such as incident state or close_code, from the sys_choice table.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Field name, e.g. state, category, or close_code.
string
required
Table name, e.g. incident.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.integer | null
Maximum number of records to return.Default:
null.Get configuration item
Action ID:tools.servicenow.get_ci
Get a configuration item, including its attributes and relations, with the CMDB Instance API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/cmdb-instance-api.html#cmdb-GET-instance-classname-sys_id
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
CMDB class (table) name, e.g. cmdb_ci_linux_server, cmdb_ci_win_server, or cmdb_ci_appl.
string
required
sys_id of the configuration item.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Get email
Action ID:tools.servicenow.get_email
Get an email record (sys_email) by sys_id with the Email API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/email-api.html#email-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the email.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Comma-separated list of fields to return.Default:
null.Get incident
Action ID:tools.servicenow.get_incident
Get an incident by sys_id with the Table API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET-id
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the incident.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.boolean | null
Exclude Table API links for reference fields.Default:
null.string | null
Comma-separated list of fields to return.Default:
null.Get record statistics
Action ID:tools.servicenow.get_record_stats
Compute counts, averages, and grouped statistics over a table with the Aggregate API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_AggregateAPI.html#aggregate-GET-stats
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Table name, e.g. incident, problem, change_request, sc_req_item, sc_task, or sn_si_incident.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Comma-separated fields to average.Default:
null.boolean | null
Return the number of matching records.Default:
null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.string | null
Comma-separated fields to group results by.Default:
null.string | null
Additional query applied to the aggregates, e.g. count^priority^>^3.Default:
null.string | null
Field to order grouped results by.Default:
null.string | null
Encoded query used to filter the result set, e.g. active=true^priority=1^ORDERBYDESCsys_created_on.Default:
null.Get ServiceNow record
Action ID:tools.servicenow.get_record
Retrieve a record from a ServiceNow table by sys_id.
Reference: https://www.servicenow.com/docs/bundle/zurich-api-reference/page/build/applications/concept/api-rest.html
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Base API URL, e.g. https://example.service-now.com/api/now.
string
required
Unique record identifier (sys_id).
string
required
ServiceNow table name, e.g. ‘incident’, ‘sys_user’.
object | null
Optional query parameters such as sysparm_fields or sysparm_display_value.Default:
null.Get table columns
Action ID:tools.servicenow.get_table_columns
List the field definitions (form fields) of a table from the sys_dictionary table. Fields inherited from a parent table, such as task for incident, are defined on the parent table.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Table name, e.g. incident or task.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Comma-separated list of fields to return, e.g. element,column_label,internal_type,mandatory,reference.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.Get user by email
Action ID:tools.servicenow.get_user_by_email
Look up users in the sys_user table by email address.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Email address of the user.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Comma-separated list of fields to return.Default:
null.List attachments
Action ID:tools.servicenow.list_attachments
List attachment metadata with the Attachment API. Use sysparm_query table_sys_id=<sys_id> to list a record’s attachments.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_AttachmentAPI.html#attachment-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Encoded query used to filter the result set, e.g. active=true^priority=1^ORDERBYDESCsys_created_on.Default:
null.List case activities
Action ID:tools.servicenow.list_case_activities
List the activity stream (comments, work notes, and field changes) of a case with the Case API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/case-api.html#case-GET-case-activities
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id or case number.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Activity types to return, e.g. comments or work_notes.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.List cases
Action ID:tools.servicenow.list_cases
List Customer Service Management cases with the Case API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/case-api.html#case-GET-case
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.string | null
Comma-separated list of fields to return.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Encoded query used to filter the result set, e.g. active=true^priority=1^ORDERBYDESCsys_created_on.Default:
null.boolean | null
Return reference fields with display values and links.Default:
null.List catalog items
Action ID:tools.servicenow.list_catalog_items
Search service catalog items and record producers (request forms).
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-GET-items
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
sys_id of the catalog to search.Default:
null.string | null
sys_id of the category to search.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Search text.Default:
null.string | null
Item type to return, e.g. sc_cat_item or sc_cat_item_producer.Default:
null.List catalogs
Action ID:tools.servicenow.list_catalogs
List service catalogs available to the caller.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-GET-catalogs
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Search text.Default:
null.List configuration items
Action ID:tools.servicenow.list_cis
List configuration items in a CMDB class with the CMDB Instance API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/cmdb-instance-api.html#cmdb-GET-instance-classname
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
CMDB class (table) name, e.g. cmdb_ci_linux_server, cmdb_ci_win_server, or cmdb_ci_appl.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Encoded query used to filter the result set, e.g. active=true^priority=1^ORDERBYDESCsys_created_on.Default:
null.List group members
Action ID:tools.servicenow.list_group_members
List members of a user group from the sys_user_grmember table.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the group.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.string | null
Comma-separated list of fields to return.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.List groups
Action ID:tools.servicenow.list_groups
List user groups, such as assignment groups, from the sys_user_group table.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.string | null
Comma-separated list of fields to return.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Encoded query used to filter the result set, e.g. active=true^priority=1^ORDERBYDESCsys_created_on.Default:
null.List incidents
Action ID:tools.servicenow.list_incidents
List incidents matching an encoded query with the Table API. Use sysparm_query number=INC0010001 to look up an incident by number.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.boolean | null
Exclude Table API links for reference fields.Default:
null.string | null
Comma-separated list of fields to return.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Encoded query used to filter the result set, e.g. active=true^priority=1^ORDERBYDESCsys_created_on.Default:
null.List journal entries
Action ID:tools.servicenow.list_journal_entries
List comments and work notes for a record from the sys_journal_field table, newest first.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the record whose journal entries to list.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Only return comments or only return work notes.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.List tables
Action ID:tools.servicenow.list_tables
List tables defined on the instance from the sys_db_object table.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Comma-separated list of fields to return.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Encoded query used to filter the result set, e.g. active=true^priority=1^ORDERBYDESCsys_created_on.Default:
null.List users
Action ID:tools.servicenow.list_users
List users from the sys_user table.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-GET
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.string | null
Comma-separated list of fields to return.Default:
null.integer | null
Maximum number of records to return.Default:
null.integer | null
Number of records to skip, for pagination.Default:
null.string | null
Encoded query used to filter the result set, e.g. active=true^priority=1^ORDERBYDESCsys_created_on.Default:
null.Order catalog item
Action ID:tools.servicenow.order_catalog_item
Order a catalog item immediately, creating a request (REQ) and requested item (RITM).
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-POST-items-order_now
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the catalog item.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Comma-separated sys_ids of additional users to order the item for.Default:
null.integer
Quantity of the item.Default:
1.string | null
sys_id of the user to order the item for.Default:
null.object | null
Form variable values keyed by variable name. Use get_catalog_item to list an item’s variables.Default:
null.Query ServiceNow records
Action ID:tools.servicenow.query_records
Query a ServiceNow table with optional filters.
Reference: https://www.servicenow.com/docs/bundle/zurich-api-reference/page/build/applications/concept/api-rest.html
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Base API URL, e.g. https://example.service-now.com/api/now.
string
required
ServiceNow table name, e.g. ‘incident’, ‘sys_user’.
object | null
Optional query parameters such as sysparm_query, sysparm_fields, or sysparm_limit.Default:
null.Resolve incident
Action ID:tools.servicenow.resolve_incident
Resolve an incident by setting state to 6 (Resolved) with a resolution code and notes.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-PATCH
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Resolution code. Choices vary by instance; use get_choice_values with table incident and element close_code.
string
required
Resolution notes.
string
required
sys_id of the incident.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string
Target incident state. OOTB 6 is Resolved.Default:
"6".Send email
Action ID:tools.servicenow.send_email
Send an email from the instance with the Email API, optionally associating it with a record.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/email-api.html#email-POST
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Email subject.
array[string]
required
Recipient email addresses.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.array[string] | null
BCC email addresses.Default:
null.array[string] | null
CC email addresses.Default:
null.string | null
HTML body.Default:
null.string | null
Table of a record to associate the email with.Default:
null.string | null
sys_id of the record to associate the email with.Default:
null.string | null
Plain-text body.Default:
null.Submit cart order
Action ID:tools.servicenow.submit_cart_order
Order all items in the caller’s cart, creating a request.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-POST-cart-sub_order
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Submit record producer
Action ID:tools.servicenow.submit_record_producer
Submit a record producer form, which creates the target record (e.g. an incident or case) from form variables.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-POST-items-submit_prod
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the record producer.
object
required
Form variable values keyed by variable name. Use get_catalog_item to list the producer’s variables.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Update cart item
Action ID:tools.servicenow.update_cart_item
Update the quantity or variables of an item in the caller’s cart.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_ServiceCatalogAPI.html#servicecat-PUT-cart
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
sys_id of the cart item.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.integer | null
New quantity.Default:
null.object | null
Form variable values keyed by variable name. Use get_catalog_item to list an item’s variables.Default:
null.Update case
Action ID:tools.servicenow.update_case
Update a Customer Service Management case with the Case API. Include comments or work_notes in fields to add journal entries.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/case-api.html#case-PUT-case
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
object
required
Field values to update, e.g. {“state”: “10”, “work_notes”: “Investigating”}.
string
required
sys_id or case number.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.string | null
Comma-separated list of fields to return.Default:
null.boolean | null
Return the full case record in the response.Default:
null.Update configuration item
Action ID:tools.servicenow.update_ci
Update attributes of a configuration item with the CMDB Instance API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/cmdb-instance-api.html#cmdb-PATCH-instance
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
object
required
CI attributes to update, keyed by field name.
string
required
CMDB class (table) name, e.g. cmdb_ci_linux_server, cmdb_ci_win_server, or cmdb_ci_appl.
string
required
Discovery source that is updating the CI. Must be a choice value of cmdb_ci.discovery_source, e.g. ServiceNow.
string
required
sys_id of the configuration item.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.Update incident
Action ID:tools.servicenow.update_incident
Update incident fields with the Table API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_TableAPI.html#table-PATCH
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
object
required
Field values to update, keyed by field name, e.g. {“state”: “2”, “priority”: “1”}.
string
required
sys_id of the incident.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string | null
Return display values (true), actual values (false), or both (all).Default:
null.string | null
Comma-separated list of fields to return.Default:
null.boolean | null
Set field values using display values instead of actual values.Default:
null.Update ServiceNow record
Action ID:tools.servicenow.update_record
Update fields on a ServiceNow table record.
Reference: https://www.servicenow.com/docs/bundle/zurich-api-reference/page/build/applications/concept/api-rest.html
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Base API URL, e.g. https://example.service-now.com/api/now.
object
required
Fields to update on the record.
string
required
Unique record identifier (sys_id).
string
required
ServiceNow table name, e.g. ‘incident’, ‘sys_user’.
object | null
Optional query parameters such as sysparm_display_value.Default:
null.Upload attachment
Action ID:tools.servicenow.upload_attachment
Attach a file to any record, such as an incident or case, with the Attachment API.
Reference: https://www.servicenow.com/docs/r/api-reference/rest-apis/c_AttachmentAPI.html#attachment-POST-upload
Secrets
Required secrets:servicenow_oauth: OAuth tokenSERVICENOW_SERVICE_TOKEN.
Input fields
string
required
Base64-encoded file content.
string
required
Name of the file.
string
required
Table of the record to attach the file to, e.g. incident.
string
required
sys_id of the record to attach the file to.
string | null
ServiceNow instance URL, e.g. https://<instance>.service-now.com. Defaults to the
servicenow.base_url workspace variable.Default: null.string
MIME type of the file.Default:
"application/octet-stream".