Web Services

Live Connect provides read-only access to your ServiceNow tables, allowing you to write SQL queries, create reports, and perform analysis while maintaining your existing security controls. This eliminates the need for data synchronization and ensures you work with current ServiceNow data.

Add the UI extension point into a UI script in the base application code. To add the extension point, place an API call that identifies the location at which registered custom artifacts execute.

Add the scripted extension point into a script include in the base application code. To add the extension point, include an API call that identifies the location at which registered custom artifacts execute.

In addition to employing inbound and outbound web services to integrate with ServiceNow apps, other resources are available to you, such as scripted GraphQL, Javascript, and API developer guides.

Certain properties control the behavior of API analytics.

Select which APIs to collect analytics for and select if requestor information should be collected for each API.

Create a GraphQL schema to make data available to GraphQL queries.

Action parameters are separate and different from data parameters because they specify the action to take when the JSON object parameter is part of an HTTP GET or POST request.

REST and SOAP API analytics allow you to track and analyze web service API usage.

API analytics uses scheduled jobs to collect and clean up analytics data.

View overall API analytics, analytics per API, or analytics per requesting user in the REST & SOAP API Analytics dashboard.

To enforce basic authentication on each request for an RSS feed, set the property glide.basicauth.required.rss to true.

Call a web service using Visual Studio 2008.

For SOAP requests initiated from your ServiceNow instance to be able to successfully communicate with the web service provider inside a remote network, the ServiceNow instance must have HTTP or HTTPS access to the SOAP endpoint at the provider.

Examples demonstrating how to use .NET to consume a ServiceNow web service.

Modify data using the JSON web service by sending an HTTPS POST request to the instance.

Query for data by issuing an HTTPS GET request to the instance.

To capture incoming SOAP envelope XML in the system log, add the property glide.processor.debug.SOAPProcessor with a value of true.

A direct web service is available for any table in the system if the correct access control list is configured.

By default, the SOAP request is accepted un-compressed and the result of the request is returned un-compressed.

The description element in the returned RSS xml can be formatted by setting the URL parameter sysparm_format=true and specifying the format string in the property glide.rss.description_format.

Before installing the ODBC driver, create an ODBC user account, assign the odbc role, and define an ACL rule for the odbc role.

Inbound web service examples demonstrate how to access ServiceNow web services.

Review setup requirements, download the ODBC driver installer, and install the ODBC driver to a computer.

Examples demonstrating an integration with Axis2 Version 1.4.

Examples showing how to construct and use an Axis2 client to consume a ServiceNow Web Service.

An example class to insert an incident record.

An example of an Axis Client program that calls the getKeys function to query all incidents where the category is Hardware.

The JSON object is built in two structures.

The ability to describe sets of data in JSON format is a natural extension to the JavaScript language.

The description element in the returned RSS xml is constructed using the view as specified in the URL, when no view is specified, the default no-name view is used.

Examples demonstrating an integration with Microsoft .NET Web Services Client.

This tutorial explains how to use an OAuth 2.0 profile to authenticate an outbound REST message with Google to retrieve contact information.

In the OAuth provider scenario, profiles and scopes specify the grant type, authorization type, and level of access.

The ServiceNow open database connectivity (ODBC) driver provides read-only access to the database associated with your ServiceNow instance.

Use the ServiceNow ODBC driver in SQL Server as a Linked Server.

Outbound REST messages support multiple types of authentication.

You can configure a REST message HTTP method to be sent through a MID Server.

Mutual authentication causes the web service provider and consumer to authenticate with each other before communicating.

ServiceNow outbound REST functionality allows you to retrieve, create, update, or delete data on a web services server that supports the REST architecture.

You can authenticate outbound SOAP messages using several different security protocols.

The SOAP Message module can be used to develop, prototype, and save outbound SOAP messages that can be reused in business rules and scripts.

Mutual authentication establishes trust by exchanging Secure Sockets Layer (SSL) certificates.

You may optionally override the automatically generated title of the RSS feed by added the sysparm_title parameter to the request URL.

The SOAP endpoint address where the SOAP message is posted is consistent with the endpoint of the WSDL.

Examples demonstrating an integration with a Perl web services client.

By default, an instance does not omit empty elements, elements with NULL or NIL values, from SOAP messages.

Examples demonstrating an integration with a Python web services client.

The following system property controls whether basic authentication is required for incoming JSONv2 requests.

JSONv2 requests may return one of several response statuses.

If you have followed the tutorial correctly, you should receive the result whether you used a Service Reference or a Web Reference.

ServiceNow supports the dynamic generation of RSS feeds.

Create a scrolling RSS feed reader using a UI page.

An example of how to set up an RSS feed reader using an RSS feed.

By default, a single SOAP request can retrieve a maximum of 250 records.

This sample ASP.NET code creates a simple authentication portal and passes an unencrypted HTTP header as a URL parameter.

Scripted SOAP web services allow a ServiceNow administrator to create custom SOAP web services.

You can send outbound REST requests from any place in the ServiceNow AI Platform where scripting is allowed.

When creating SOAP message functions, you can configure the function to be sent through a MID Server.

The following system property controls how many rows JSON returns with each query.

Information needed to send SOAP requests is stored in SOAP message records.

After you create a SOAP message record, you can click Generate sample SOAP messages to populate the SOAP Message Functions related list.

Retrieve the information that you need and make your integration more efficient.

Simple Object Access Protocol (SOAP) is an XML-based protocol for accessing web services over HTTP.

After defining the source code, insert it.

Test an HTTP method for an outbound REST message to ensure that the request is valid and the response returns as expected.

Test a SOAP message to validate the configuration before using the message in an integration.

Receiving a null response from ServiceNow's web service.

Use a wizard to add a service reference for a C Sharp integration.

Generate a sample script to send the SOAP message.

Use a wizard to add a web reference for a C Sharp integration.

A REST function URI or function variable may use special characters, such as pipe (|) characters.

You can use variables when creating outbound REST messages and assign values to those variables when performing a request.

To use variable substitution, use the format ${<variable_name>} instead of defining a specific value.

You can pass an empty value through a SOAP parameter to clear the respective value in the target instance.

Use client extension points in client-side UI scripting to modify forms, so that you do not have to directly modify the form. By using client extension points, you can integrate customizations without actually altering the core components in the application code.

Live Connect supports business intelligence (BI) reporting, ad-hoc data analysis, and custom report development.

Configure ServiceNow Live Connect drivers to connect with third-party business intelligence and database tools for direct data access and analysis.

Configure the JDBC driver to connect to your ServiceNow instance and query your data.

Configure the ODBC driver with your instance URL, BCFIPS JAR file paths, and authentication credentials to enable BI tools to access your ServiceNow data.

You can set two ODBC driver properties to deal with errors you receive when using queries that return large amounts of data.

The ODBC driver can be configured to route its HTTP SOAP requests via an HTTP proxy server.

After installing the ODBC driver, configure it to connect to your ServiceNow instance and to communicate through a proxy server, if applicable, and set properties to control ODBC behavior.

Configure your ServiceNow instance to enable Live Connect access, set up security controls, and install the required drivers on your client machine.

Connect the DB Visualizer database tool to your ServiceNow instance using the JDBC driver to query ServiceNow data. Access authorized tables and perform read-only queries on your ServiceNow data to create visualizations, and perform ad-hoc analysis using industry-standard SQL commands.

Connect Power BI Desktop to your ServiceNow instance using the ODBC driver to access and analyze ServiceNow data. Create dashboards and reports that visualize your ServiceNow data.

Grant user accounts query access to specific ServiceNow tables through Live Connect using table-level ACLs.

Create a client extension point that you can place in the UI scripts in the application code. By placing the client extension point, you designate the specific location in the application code where data or objects can be sent to a customization, and where data is returned.

Define which IP addresses or IP ranges are permitted to connect to your ServiceNow instance via the Live Connect ODBC/JDBC driver.

Create a scripted extension point that can be placed in a script include in the base application code. By placing the scripted extension point, you designate the specific location in the application code where data or objects can be sent to a customization and where data is returned.

Assign the sn_odbc_rest_access or sn_jdbc_rest_access role to users who need Live Connect access. You can assign these roles to personal user accounts or create dedicated non-interactive (Machine) service accounts.

Create a SOAP message from a WSDL and external XSD file.

Follow these examples to create a new scripted SOAP web service.

Follow these examples to create a scripted SOAP web service using a static WSDL.

This is an overview of domain separation and ODBC drivers.Domain separation enables you to separate data, processes, and administrative tasks into logical groupings called domains. You can control several aspects of this separation, including which users can see and access data.

Domain separation is supported in Web Services. Domain separation enables you to separate data, processes, and administrative tasks into logical groupings called domains. You can control several aspects of this separation, including which users can see and access data.

Download ODBC and JDBC drivers to enable third-party Business Intelligence tools and data analysis platforms to connect to your ServiceNow instance data.

Discover the queries and mutations supported by schemas on your instance by enabling introspection.

Configure OAuth as an additional authentication method for Live Connect connections. This adds OAuth alongside basic authentication without replacing it.

Use extension points to extend the functionality of an application without altering the original application code. You can use pre-existing extension points available in selected ServiceNow AI Platform applications, or you can add extension points when you develop custom applications in your own instance.

The ServiceNow Live Connect provides data access to your ServiceNow instances through industry-standard ODBC and JDBC drivers, enabling direct connections from Business Intelligence (BI) tools and data analysis platforms.

Configure GraphQL API framework behavior. For example, you can configure whether to allow introspective queries into your schema.

Create client extension points and add them to the client-side UI scripts in the base application code.

When developing an application, create scripted extension points and add them to the script includes in the application code. Use a scripted extension point to designate the specific location where data or objects can be sent to a registered custom script include and where returned results are processed.

When developing an application, create UI extension points and add them to the server-side UI macros, such as HTML extensions, or the UI pages in the base application code.

Register custom UI macros against a selected UI extension point in the application code.

Monitor inbound integration usage requests, data egress, and domain-level usage through the Inbound API Integration Usage dashboard.

You can use any of several web services to integrate with ServiceNow applications, including REST, SOAP, JSONv2, and RSS.

Use ServiceNow patches to install incremental ODBC fixes that occur between major ODBC releases.

Use the installation wizard to install the ODBC driver and configure the connection between your Business Intelligence tools and ServiceNow data.

Install Live Connect to enable secure, read-only access to your instance data from external applications.

The following properties are available for long-running SOAP requests.

This section lists the minimum supported versions for ServiceNow server releases, client drivers (ODBC and JDBC), and Java Development Kit required for Live Connect.

Set these properties on the ODBC or JDBC driver to connect to Live Connect using OAuth instead of a username and password.

Review these troubleshooting resources to resolve issues with the ODBC driver.

You can configure outbound request logging to log basic, elevated, or all HTTP request and response information for specific domains.

When you exclude outbound request logging for a domain, the value you enter in the Domain field must meet certain requirements.

These properties allow you to control the behavior of outbound web service request logging.

Log requests and responses for outbound web services such as REST and SOAP.

You can use any of several outbound web services to integrate with ServiceNow applications, including REST and SOAP.

RSS (Rich Site Summary) is a format for delivering web-based information that changes regularly.

In circumstances when a SOAP client makes many calls in a short amount of time, you may want to re-use a single HTTP session for all SOAP calls.

The ServiceNow ODBC driver for Power BI Desktop supports only import mode, not DirectQuery. Understanding this distinction helps you plan refresh schedules and avoid dataset size and large-table filtering issues in your reports.

Access record data in a component by querying your scripted GraphQL schema.

Query a table using an aggregate function including SUM, COUNT, MIN, MAX, LAST, and AVG.

This sample ASP.NET code creates a simple authentication portal and passes an unencrypted HTTP header as a cookie.

You can send an outbound SOAP message asynchronously.

Attach documents to records in ServiceNow by sending a SOAP message targeting the ecc_queue table.

HTTP-based web services allow diverse applications to talk to each other. ServiceNow supports both inbound (provider) and outbound (consumer) web services.

Samples of basic authentication code for several programming languages and versions.

Certain properties provide support for SOAP requests to use a web proxy server.

Data Modification API method summaries and descriptions.

Data Retrieval API method summaries and descriptions.

Delete multiple records from the targeted table by example values.

Delete a record from the targeted table by supplying its sys_id.

You can send an outbound REST message directly to the endpoint.

You can send an outbound SOAP message directly to the endpoint.

The standard SOAP API is a set of small, globally defined functions that can be performed on a targeted resource.

If a local data store is not an option, another way to get the data is to call the CSV/XML processor directly and then parse the results.

Query a single record from the targeted table by sys_id and return the record and its fields.

Query the targeted table by example values and return a comma delimited sys_id list.

Query the targeted table by example values and return all matching records and their fields.

When the SOAP message is constructed from the hierarchical web service described by the WSDL and invoked, it will create the incident, u_custom_comments, and u_comment_items records.

Outbound HTTP(S) connections from a base system instance or inbound connections from MID Servers, the ODBC driver, and other clients are maintained and reused where possible.

Connection pooling is controlled by three properties.

Creates a new record for the table targeted in the URL.

Creates multiple new records for the table targeted in the URL.

The following components installed with the Enhanced Web Service Provider - Common plugin.

If a large amount of data needs to be queried often, and the data does not need to be real-time, perform a sync of the ServiceNow table that you're interested in with your integrating application's data store.

By default, ServiceNow only returns 100 rows of data with each iSQL query. If you need to return more rows of data, set the maxrows parameter for the iSQL session.

See the following pages for examples of how to use the ODBC driver to create data sources from other applications.

After testing the ODBC driver, you can use it to query your instance database from a variety of client applications.

Install the ServiceNow ODBC driver on Microsoft Windows computers.

Watch video tutorials about configuring and troubleshooting the ODBC driver with a SQL Linked Server.

The following video tutorial demonstrates how to configure outbound SOAP web service messages to consume third-party web services from an instance.

This example scrolling element demonstrates how to create a UI macro to a scrolling list of priority 1 incidents.

You can use the RESTMessageV2() constructor with no parameters to define a REST message entirely in the script.

You can use the SOAPMessageV2() constructor with no parameters to define a SOAP message entirely in the script.

An outbound REST message is composed of several elements, such as the endpoint and HTTP methods.

You can send an outbound REST message through a MID Server.

You can send outbound SOAP requests from any place in the ServiceNow AI Platform where scripting is allowed.

A scrollable area is a div where contents scroll from the bottom up over time.

The following properties customize connectivity and optimize the query behavior of the ODBC driver.

An example of a valid WS-Security SOAP envelope header.

You can send an outbound SOAP message through a MID Server.

The ODBC driver embeds a third party SQL/ODBC engine from DataDirect, a division of Progress Software.

This example demonstrates the FakeStockValue WSDL.

This example demonstrates the processing script for the FakeStockValue web service.

This example demonstrates the FakeStockValue script include that implements much of the static WSDL behavior.

Updates an existing record in the targeted table in the URL, identified by the mandatory sys_id field.

One way to make your web service calls fit within the 250 record limit is to think about the design of your integrating application.

Load the static WSDL into a SOAP client to make requests to the SOAP web service.

An instances produces one of the following error messages when it encounters an issue with a WS-security SOAP message.

When a WSDL for the target Incident table is requested with an additional parameter of hierarchical=true, the WSDL schema for the Insert function will reflect available related records that may participate in the hierarchical data payload.

Register basic authentication for your inbound API integrations to effectively monitoring their API usage on the Inbound API Usage Dashboard.

View the list of all the inbound API integrations registered on ServiceNow.

To retrieve or set choice fields, use the choice Value, not the Label.

To get the contents of a journal field, make a second soap request against the sys_journal_field table to pull the appropriate journal records back for the record in question.

When you query a record using a get or getRecords function, the instance returns all fields associated with that record. The fields are often reference fields that contain a sys_id for a record on another table.

Route Live Connect calls to a Read Replica database to reduce the processing load on the primary database in your ServiceNow instance.

Use the scripted extension points in the server-side script includes that store JavaScript functions and object classes. By using extension points, you can integrate customizations without actually altering the core components in the application code.

Create a custom GraphQL API to query record data from a component or a third-party system.

Web service import sets complement direct web services and scripted SOAP web services by providing a web service interface to import sets tables.

You can specify a connection string instead of defining a DSN.

Live Connect provides secure, read-only access to ServiceNow data for external BI platforms via industry-standard database APIs, while maintaining all existing security policies and role-based restrictions.

Use URL parameters to export table records and convert them into complex data types, such as JSON, XML, PDF, CSV, and XLS.

Common SQL functions used in Live Connect for querying and analyzing incident data.

Administrators can activate the Enhanced Web Service Provider - Common plugin to enable unsigned WS-Security requests and specify what authentication requirements SOAP requests have.

You can add scrolling areas to forms as well as UI pages.

If the endpoint requires a user name and password, you can provide credentials using basic authentication.

Change the logging level of the ODBC driver.

You can configure an outbound REST message to send OAuth credentials with the request.

Configure web services within ServiceNow.

Configure an outbound REST message to provide basic authentication credentials with each request.

Administrators can configure web service security for inbound SOAP requests made to the ServiceNow instance.

Configure the global default used by all newly created DSNs.

Configure the ODBC driver to connect to your ServiceNow instance.

Send requests to a REST web service endpoint by creating a REST message record.

The following example configuration was performed on SQL Server 2008, installed on Windows Server 2008.

Create a basic auth profile to specify basic authentication credentials for one or more REST messages.

Administrators can specify which security profiles WS-Security communications must meet by creating a new security policy.

Create a new WS Security profile to define how to authenticate a web services message when WS-Security is enabled.

The ODBC driver communicates with your ServiceNow instance as a specific user. Create an ODBC user account and assign the odbc role to enable the user to communicate via ODBC.

You can create a custom HTTPS protocol profile to specify the credentials and certificates used for outbound web services. For example, you can create a custom HTTPS protocol profile to enable mutual authentication.

Create a SOAP message to define the remote endpoint, WSDL, and authentication settings.

Create a script include to define the majority of the code used to process static WSDL requests.

Create a static WSDL with the required format to override the standard WSDL for your scripted web service.

To use a static WSDL, create a scripted web service.

Use the ODBC driver and the ServiceNow data source to create an unlimited number of DSNs configured to connect with different instance URLs.

Follow this example to customize and control the XML payload of a SOAP response.

Define an ACL rule for the odbc role to provide read access to the incident table. You can create other ACL rules for the odbc role to provide read access to other tables.

Define an HTTP header for a REST message or HTTP method to send that header with REST requests.

Define an HTTP method such as GET or POST to send a request to a web service provider.

Download the ODBC driver (32-bit or 64-bit) that is compatible with your computer's operating system from the ServiceNow Store.

You can configure a SOAP or REST message for mutual authentication using a protocol profile.

Administrators can enable Web Services Security (WSS) verification from the Web Services system properties.

Strict security for web services requires that users meet Contextual Security requirements to access instance resources.

If you experience unexpected behavior when using the ODBC driver, you can enable debug logging and generate debug logs to help identify the issue.

Populate the list of variable substitutions automatically based on variables defined in several REST message HTTP method fields.

The ODBC driver limits the field length in SQL queries to the maximum length defined by the ServiceNow dictionary entry. You can increase the maximum field length to avoid truncating data.

Support is available for inserting hierarchical data into tables or web service import set tables. The hierarchical data in the Insert API is automatically mapped to related records of the targeted table.

Allow internal integration communications to bypass the WSS authentication requirement by marking their user accounts as internal integration users.

Use the Google Developer Console to set up an OAuth 2.0 provider.

Set up the Google service as an OAuth provider in ServiceNow by entering your client information, Google API URLs, and configuring the OAuth profile.

Create a REST message and associated HTTP method to contact the Google service using the OAuth 2.0 profile.

You can generate an example script to send a REST message based on content and parameters you provide in the method record.

Set the SOAP default security policy.

An OAuth profile includes the grant type that the third-party OAuth provider needs to obtain access to the restricted resource.

Specify the OAuth scopes that you get from the provider. Scopes can be any level of access specified by the provider, such as read, write, or any string, including a URL.

Use a SOAP security policy to specify whether the instance requires signed SOAP requests for all inbound SOAP traffic.

To verify that the user has the appropriate permissions to send requests to the instance using ODBC, run a query using Interactive SQL.

After configuring the ODBC driver, test that the driver can connect to the base instance as the ODBC user and can query data from a target table.

If you have previously installed an older version of the ODBC driver, run the installer to uninstall the previous version, and then run the installer again to upgrade.

Each client application must register with the instance to participate in OAuth authorization.

After installing the ODBC driver and its associated DSN, use it in Crystal Reports as a data source provider.

Run the Interactive SQL application for quick verification of connectivity and to test query results without using a full application.

After installing the ODBC driver and its associated DSN, use it in Excel as a data source provider.

You can view a user's log from a SOAP session.

You can sign outbound SOAP messages using username and password or a key store and trusted server certificate saved on the instance.

Test query your GraphQL APIs using an integrated GraphQL testing tool.

Use Interactive SQL to verify that the ODBC driver connects to your ServiceNow instance and returns query results.

This section provides details about Live Connect reference information like minimum requirements and usage limitations.

Use UI extension points in the server-side UI macros, such as HTML extensions, to add custom content to a UI page without having to directly modify the page. By using UI extension points, you can integrate customizations without actually altering the core components in the application code.

Live Connect imposes rate limits to ensure system stability and performance when querying ServiceNow data through ODBC and JDBC drivers.

On occasion, there is a need to limit the number of field values that a SOAP query returns.

View integration request counts, data egress volume, and domain-level usage.

These properties control the behavior of WS-Security X.509 tokens.

Support for WS-Security 1.1 in the form of WSS X.509 Token Profile and WSS Username Token Profile is available for incoming SOAP requests.