This website uses cookies. By clicking Accept, you consent to the use of cookies. Click Here to learn more about how we use cookies.
Accept
Reject
Community FAQ
cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Glossary

This documentation is for the new preview UI. It’s still being refined and is subject to change. For documentation for the old UI, see Knowledge Base.

ServiceNow Connector

Article link copied to clipboard
Updated

on ‎10-31-2025 12:27 PM - edited a month ago by Lansweeper Employee

Published
‎10-31-2025 12:27 PM
16 min read
Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

Create records and incidents within ServiceNow

Connections

Basic Username/Password

Basic Username and Password connection

Input Comments Default
Username Username
Password Password

OAuth 2.0 Authorization Code

OAuth 2.0 Authorization Code flow

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.

Input Comments Default
Authorize URL The OAuth 2.0 Authorization URL for ServiceNow
Token URL The OAuth 2.0 Token URL for ServiceNow
Scopes Space separated OAuth 2.0 permission scopes for ServiceNow
Client ID Client Identifier of your app for ServiceNow
Client Secret Client Secret of your app for ServiceNow

Actions

Create Configuration Item

Creates a single configuration item (CI) with the specified outbound and inbound relations within the specified Configuration Management Database (CMDB) table.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Class Name CMDB class name. This is the name of the table that contains the desired CI records
Configuration Item Attributes The attributes of the configuration item to create.
Configuration Item Inbound Relations The inbound relations of the configuration item to create.
Configuration Item Outbound Relations The outbound relations of the configuration item to create.
Configuration Item Source Entity that created/updated the information. This must be one of the choice values specified in the discovery_source field in the Configuration Item [cmdb_ci] table.

Create Incident

Creates an Incident with the specified field names and values

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Values The names of the fields and their values to use when creating a record

Create Table Record

Creates a record in the specified table with the specified field names and values

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Table The name of the ServiceNow table in which to create a record
Values The names of the fields and their values to use when creating a record

Create User

Creates a User with the specified field names and values

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Values The names of the fields and their values to use when creating a record
First Name The User's First Name
Last Name The User's Last Name
Email The Email of the User
User Id The Username of the User

Delete Attachment

This method deletes the attachment with a specific sys_id value.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sys ID Sys_id value of the attachment to delete.

Delete Configuration Item

Deletes the relation for the specified configuration item (CI).

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Class Name CMDB class name. This is the name of the table that contains the desired CI records
Sys ID The Sys ID of the record being queried
Relationship Sys ID Sys Id of the relation to perform the operation on.

Delete Incident

Delete an Incident

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sys ID The Sys ID of the record being queried

Delete Table Record

Delete a record for a given ID in the specified Table

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Table The name of the ServiceNow table in which to create a record
Sys ID The Sys ID of the record being queried

Delete User

Deletes a User

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sys ID The Sys ID of the record being queried

Get Attachment

Returns the metadata for the attachment file with a specific sys_id value.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sys ID The Sys ID of the record being queried

Get Attachment File

Returns the binary file attachment with a specific sys_id value.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sys ID The Sys ID of the record being queried

Get CMDB Class Metadata

Returns the meta data for the specified CMDB class

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Class Name CMDB class name. This is the name of the table that contains the desired CI records

Get Configuration Item Attributes

Returns attributes and relationship information for a specified configuration item (CI) record

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Class Name CMDB class name. This is the name of the table that contains the desired CI records
Sys ID The Sys ID of the record being queried

Get Incident

Gets an Incident by ID

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sys ID The Sys ID of the record being queried

Get Knowledge Article

Returns specific knowledge article content and its field values.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Article ID Sys_id or knowledge base (KB) number of a knowledge article in the Knowledge [kb_knowledge] table.
Fields Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results.
Language List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance.
Search ID Optional unless using the 'Search Rank' input. Unique identifier of search that returned this article. You can retrieve this value (articles.id element) using the 'List Knowledge Articles' action.
Search Rank Optional unless using the 'Search ID' input. Article search rank by click-rate (articles.rank) that you can retrieve using the 'List Knowledge Articles' action.
Update View Update view count and record an entry for the article in the Knowledge Use [kb_use] table. false

Get Knowledge Article Attachment

Returns a knowledge article attachment as a file.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Article Sys ID Sys_id of the knowledge article with the attachment you intend to retrieve. Located in the Knowledge Bases [kb_knowledge] table.
Attachment Sys ID Sys_id of record to which the attachment belongs.

Get Table Record

Get a record for a given ID in the specified Table

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Table The name of the ServiceNow table in which to create a record
Sys ID The Sys ID of the record being queried

Get User by Id

Gets a User by their Id

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sys ID The Sys ID of the record being queried

Get User by Username

Get a record for a given ID in the specified Table

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
User Id The Username of the User

List Attachments

Returns the metadata for multiple attachments.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sysparm Limit Limit to be applied on pagination. Default is 1000. Unusually large values can impact system performance.
Sysparm Offset Starting record index for which to begin retrieving records. 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.
Sysparm Query Encoded query used to filter the result set. Syntax: sysparm_query=<col_name>.

List Configuration Items

Returns the available configuration items (CI) for a specified Configuration Management Database (CMDB) class (table)

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Class Name CMDB class name. This is the name of the table that contains the desired CI records
Sysparm Limit Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval. Allows numbers from 0 to 100.
Sysparm Offset 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.
Sysparm Query All parameters are case-sensitive. Queries can contain more than one entry, such as sysparm_query=<col_name>[<col_name>]. Refer to https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/integrate/inbound-rest/concept/cm... for more information.

List Featured Knowledge Articles

Returns a list of the most-viewed knowledge articles and featured knowledge articles.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Fields Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results.
Knowledge Base Sys ID's Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to.
Language List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance.
Limit Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the Offset input to paginate record retrieval.
Offset 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 this endpoint is called, offset is set to '0'.

List Incidents

Gets a list of all Incidents

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sysparm Limit Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset
Sysparm Offset Starting record index for which to begin retrieving records. 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.
Sysparm Query Encoded query used to filter the result set. Syntax: sysparm_query=<col_name>.

List Knowledge Articles

Returns a list of knowledge base (KB) articles which can be searched and filtered using various parameters.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Filter Encoded query to use to filter the result set.
Fields Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results.
Knowledge Base Sys ID's Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to.
Language List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance.
Limit Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the Offset input to paginate record retrieval.
Offset 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 this endpoint is called, offset is set to '0'.
Query Text to search for, can be empty.

List Most Viewed Knowledge Articles

Returns a list of knowledge articles prioritized by most-viewed.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Fields Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results.
Knowledge Base Sys ID's Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to.
Language List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance.
Limit Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the Offset input to paginate record retrieval.
Offset 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 this endpoint is called, offset is set to '0'.

List Table Records

Lists records in the specified table

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Table The name of the ServiceNow table in which to create a record
Sysparm Limit Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset
Sysparm Offset Starting record index for which to begin retrieving records. 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.
Sysparm Query Encoded query used to filter the result set. Syntax: sysparm_query=<col_name>.

List Tables

Retrieve a list of all tables

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
Sysparm Fields Comma-separated list of fields to return. If not specified, all fields are returned.
Sysparm Limit Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset
Sysparm Offset Starting record index for which to begin retrieving records. 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.
Sysparm Query Encoded query used to filter the result set. Syntax: sysparm_query=<col_name>.

List Users

Gets a list of all Users

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sysparm Limit Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset
Sysparm Offset Starting record index for which to begin retrieving records. 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.
Sysparm Query Encoded query used to filter the result set. Syntax: sysparm_query=<col_name>.

Multipart Upload Attachment

Uploads a multipart file attachment.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
File The file to attach to the record.
File Name Name to give the attachment.
Table Name of the table to which you want to attach the file.
Sys ID Sys_id of the record on the specified table to which you want to attach the file.

Raw Request

Send raw HTTP request to ServiceNow

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Table The name of the ServiceNow table in which to create a record
Sys ID The Sys ID of the record being queried
Method The HTTP method to use.
Data The HTTP body payload to send to the URL.
Form Data The Form Data to be sent as a multipart form upload.
File Data File Data to be sent as a multipart form upload.
File Data File Names File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header A list of headers to send with the request.
Response Type The type of data you expect in the response. You can request json, text, or binary data. json
Timeout The maximum time that a client will await a response to its request
Retry Delay (ms) The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. 0
Retry On All Errors If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. false
Max Retry Count The maximum number of retries to attempt. Specify 0 for no retries. 0
Use Exponential Backoff Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. false

Update Configuration Item

Updates a single configuration item (CI) with the specified outbound and inbound relations within the specified Configuration Management Database (CMDB) table.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
Sys ID The Sys ID of the record being queried
API Version The version of the ServiceNow API file_name, to use
Class Name CMDB class name. This is the name of the table that contains the desired CI records
Configuration Item Source Entity that created/updated the information. This must be one of the choice values specified in the discovery_source field in the Configuration Item [cmdb_ci] table.
Configuration Item Attributes The attributes of the configuration item to create.

Update Incident

Updates an Incident with the specified field names and values

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sys ID The Sys ID of the record being queried
Values The names of the fields and their values to use when creating a record

Update Table Record

Updates a record in the specified table with the specified field names and values

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Table The name of the ServiceNow table in which to create a record
Sys ID The Sys ID of the record being queried
Values The names of the fields and their values to use when creating a record

Update User

Updates a User with the specified field names and values

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
Sys ID The Sys ID of the record being queried
Values The names of the fields and their values to use when creating a record
User Id The Username of the User
Email The Email of the User
First Name The User's First Name
Last Name The User's Last Name

Upload Attachment

Uploads a specified binary file as an attachment to a specified record.

Input Comments Default
Connection
Instance URL The URL of the specific ServiceNow instance to use for API requests
API Version The version of the ServiceNow API file_name, to use
File The file to attach to the record.
File Name Name to give the attachment.
Table Name of the table to attach the file to.
Sys ID Sys_id of the record in the table specified in table_name that you want to attach the file to.