Developer Guides

Add a custom button to the Agent Workspace Lists page that returns list information in the current view. Define the information to return by adding client GlideList API methods to an action assignment.

Use the Alarm Management Open API to create and update data in the Events [em_event] table.

This developer guide describes how to define custom invoice fields that aren’t provided by default with the AP Invoice API for Accounts Payable Invoice Processing. Instructions are also provided for setting authentication when using cXML as the payload.

The Run UI Test Script test step runs a client-side test script in the browser to drive and verify the user interface with no server-side execution needed. Use this step to automate multi-step UI journeys on both classic and Now Experience pages, like navigating, filling fields, clicking, impersonating users, uploading attachments, and asserting page state.

Learn how to use extension points to extend ServiceNow Telecommunications Service Operations Management (TSOM) connector behavior without modifying any default code.

These developer guides can help you integrate your applications with the ServiceNow AI Platform.

Use the Event Notification Management Open API to create, update, and delete event records in the Events [em_event] table.

Learn how to produce an outbound notification from a ServiceNow instance using the open message bus. Customers can consume the details of the notification from the message bus in their external system.

The GlideGeoPoint developer guide contains information about how to compute distances between latitude and longitude values (geopoints), return locations within given geopoint and radius values, and use additional functionality provided by supported GlideGeoPoint API functions.

Register the push notification so that all users of your application receive the push notifications by default.

You must enter your Google Firebase Cloud Messaging server key in your push application record to use push notifications in a Mobile SDK application that leverages Virtual Agent and push notifications.

The push notification message content record contains the location users are directed to when they tap on a notification, as well as the appearance and layout of the notification.

Configure the message displayed to users when they receive their push notification.

You can pass an optional NowChatConfiguration parameter when starting a chat session to modify some of the behavior of NowChat.

The NowUIColoring interface contains all the colors used by all NowSDK modules.

Within the Mobile SDK, when interacting with data from a ServiceNow instance through a REST endpoint, you can configure what data is passed back in the return results.

You must configure your ServiceNow instance to accept and exchange a JSON Web Token (JWT) for an OAuth access token. To enable this functionality you must install a certificate that matches the JWT provider’s private key on the ServiceNow instance that you will use as the JWT Token consumer and create an OAuth Entity on that instance.

To enable SDK services to be accessible by unauthenticated users, you must configure the Mobile SDK on your ServiceNow instance to allow guest user access. A guest user can view public web pages hosted in an instance using NowWeb, have a conversation as a guest using NowChat, access public data on the instance using NowTableService and NowGraphQLService, and access custom API services configured for unauthenticated users using NowAPIService.

Before writing any application that leverages the Mobile SDK for Android, you must configure your project to use the SDK.

You can display web pages hosted within your ServiceNow instance in your native Android application.

Before you can create mobile applications that interact with your ServiceNow instance, you must first download and install the ServiceNow Mobile SDK Android library.

You must complete the tasks outlined in this section to prepare your development environment to support writing Android applications that integrate with the ServiceNow Mobile SDK.

The Mobile SDK enables you to easily implement Virtual and Live Agent chat services within your Android application.

In order to use the Mobile SDK in your application, you need to perform SDK initialization, authorization, and logging.

Before writing any application that leverages the Mobile SDK, you must install and configure the Mobile SDK scoped application.

The Mobile SDK enables you to interact with data in tables that reside on your ServiceNow instance. You can interact with this data through the ServiceNow REST Table API using the NowTableService() API that directly calls the REST interface, or through the NowGraphQLService() API that executes a specified GraphQL query against the REST GraphQL API.

The Mobile SDK provides functionality that enables Android applications to call the public REST API on a ServiceNow instance.

Modify the Virtual Agent Message Push Notification record to include your application. This record is used to trigger notifications to the Virtual Agent. All applications that will push notifications to the Virtual Agent must be configured in this record.

The NowSDK is the top-level entity of the Mobile SDK class framework.

Use the NowVoice module to embed a real-time AI voice agent session into your Android application.

The ServiceNow Mobile SDK enables you to leverage the functionality and resources of the ServiceNow platform within your standalone mobile Android applications.

Within the Mobile SDK, when interacting with data from a ServiceNow instance through a REST endpoint using the NowTableService, you can create a Paginator object that enables you to iterate over the records in the return results.

Push notifications enable the sending of unsolicited messages (notifications) from a ServiceNow instance to a specific registered user and an application that leverages the ServiceNow Mobile SDK framework.

The NowAttachmentService API enables you to perform CRUD operations on attachments and retrieve attachment metadata from your ServiceNow instance.

You must retrieve your unique Google Firebase push server key from your Firebase account so that you can associate it to your Mobile SDK applications that leverage push notifications.

In addition to the tasks that you must perform on your ServiceNow instance to configure a push notification, you must also include specific code in your Android application.

For each Mobile SDK application that incorporates the Virtual Agent service and leverages push notifications, you must complete the following configuration process on your ServiceNow instance.

Within the Mobile SDK, when writing data to a ServiceNow instance through a REST endpoint, you can define field write options.

To enable SDK services to be accessible by unauthenticated users, you must configure the Mobile SDK on your ServiceNow instance to allow guest user access. A guest user can view public web pages hosted in an instance using NowWeb, have a conversation as a guest using NowChat, access public data on the instance using NowTableService and NowGraphQLService, and access custom API services configured for unauthenticated users using NowAPIService.

After generating your iOS push certificate, you must save the push certificate record to your instance. The push certificate is stored in the X.509 Certificate [sys_certificate] table.

Register the push notification so that all users of your application receive the push notifications by default.

You must create a push application record and enter your Apple Push Notification certificate in that record to use push notifications in a Mobile SDK application that leverages Virtual Agent and push notifications.

The push notification message content record contains the location users are directed to when they tap on a notification, as well as the appearance and layout of the notification.

Configure the message displayed to users when they receive their push notification.

It is important to disable rebuild from bitcode when archiving your application for publication for release.

Within the Mobile SDK, when interacting with data from a ServiceNow instance through a REST endpoint, you can configure what data is passed back in the return results.

You must configure your ServiceNow instance to accept and exchange a JSON Web Token (JWT) for an OAuth access token. To enable this functionality you must install a certificate that matches the JWT provider’s private key on the ServiceNow instance that you will use as the JWT Token consumer and create an OAuth Entity on that instance.

Before writing any application that leverages the Mobile SDK for iOS, you must configure your project to use the SDK.

You can display web pages hosted within your ServiceNow instance in your native iOS application.

Before you are able to create mobile applications that interact with your ServiceNow instance, you must first download and install the ServiceNow Mobile SDK libraries.

You must complete the tasks outlined in this section to prepare your development environment to support writing iOS applications that integrate with the ServiceNow Mobile SDK.

The Mobile SDK enables you to easily implement Virtual and Live Agent chat services within your iOS application.

To access the functionality provided by the NowSDK, you must first initialize the NowSDK in your application.

Before writing any application that leverages the Mobile SDK, you must install and configure the Mobile SDK scoped application.

The Mobile SDK enables you to interact with data in tables that reside on your ServiceNow instance. You can interact with this data through the ServiceNow REST Table API using the NowTableService() API that directly calls the REST interface, or through the NowGraphQLService() API that executes a specified GraphQL query against the REST GraphQL API.

The Mobile SDK provides functionality that enables iOS applications to call the public REST API on a ServiceNow instance.

Modify the Virtual Agent Message Push Notification record to include your application. This record is used to trigger notifications to the Virtual Agent. All applications that will push notifications to the Virtual Agent must be configured in this record.

The NowSDK is the top-level entity of the Mobile SDK class framework.

Use the NowVoice module to embed a real-time AI voice agent session into your iOS application.

The ServiceNow Mobile SDK enables you to leverage the functionality and resources of the ServiceNow platform within your standalone mobile iOS applications.

Within the Mobile SDK, when interacting with data from a ServiceNow instance through a REST endpoint using the NowTableService, you can create a Paginator object that enables you to iterate over the records in the return results.

You can pass chat context variables when starting a chat session by passing the contextData parameter.

Push notifications enable the sending of unsolicited messages (notifications) from a ServiceNow instance to a specific registered user and an application that leverages the ServiceNow Mobile SDK framework.

The NowAttachmentService API enables you to perform CRUD operations on attachments and retrieve attachment metadata from your ServiceNow instance.

You must retrieve your unique iOS push certificate from your Apple Developer account so that you can associate it to your Mobile SDK applications that leverage push notifications.

In addition to the tasks that you must perform on your ServiceNow instance to configure a push notification, you must also include specific code in your iOS application.

For each Mobile SDK application that incorporates the Virtual Agent service and leverages push notifications, you must complete the following configuration process on your ServiceNow instance.

The NowData framework provides the ability to easily transform data into records.

Use NowUIColoring to create themes with NowWebThemeable, NowChatThemeable, and NowVoiceThemeable. The NowUIColoring interface contains all the colors used by all NowSDK modules.

The iOS implementation of the Mobile SDK provides the additional functionality of coders and Codable models.

Within the Mobile SDK, when writing data to a ServiceNow instance through a REST endpoint, you can define field write options.

If you want guest users to be able to interact with data within a table on your ServiceNow instance, you must configure the table to be guest accessible.

Learn how to configure business rules on a ServiceNow instance to recognize new Order Management events and push them into the notification system.

When adding a new trouble ticket event to your implementation, you must add a business rule to your ServiceNow instance.

The base implementation of trouble ticket notification includes a set of trouble ticket events to demonstrate the capabilities of the system.

When adding a trouble ticket event to your implementation, you must create a function that generates the required TMF-compliant payload for that event type. In addition, you must add that function to the case statement that directs the logic to this function when processing this type of event record.

The base trouble ticket event notification implementation provides multiple default trouble ticket event type examples. You may need to alter the payloads for these events within your implementation to meet your actual needs. You may also need to configure the payload for any new trouble ticket events that you add to your implementation.

If you are using the Hermes Messaging Service in your instance, you must configure the Producer Event Notification Framework for the Kafka message-bus.

If you have deployed or plan to deploy the Open Message Bus in your instance, you must configure the Producer Event Notification Framework for this message-bus. You can deploy this message-bus for both cloud and on-premise instances.

The Event Management Topic Open API enables you to save topic records in the Topic [sn_api_notif_mgmt_topic] table after validating the topic payload.

The Producer Event Notification Framework for Telecommunications, Media, and Technology enables the external distribution of events, such as trouble tickets, using a message-bus implemented in your network.

Use the Product Order Open API to create, update, and retrieve product order information.

Reference example scripts to use in a Run UI Test Script step.

The expect API makes assertions about elements or values in a Run UI Test Script step. Pass a DOM element for element-specific matchers, or pass any other value for value matchers.

A Run UI Test Script step provides 4 global helper functions for polling, scoping queries, and reading data from other parts of the test: waitFor, within, steps, and params.

Element predicates are synchronous Boolean checks available in a Run UI Test Script step. Use them inside .find() or .filter() callbacks to pick one element from a list based on its state.

The screen API is the primary interface for finding elements on the page tested by a Run UI Test Script step. All query methods pierce shadow roots automatically, so they work with Now Experience components as well as classic Jelly and UI16 pages.

The sn_atf API provides utility methods for a Run UI Test Script step: navigation, page evaluation, impersonation, file uploads, and shadow-DOM utilities.

Resolve common issues with the Run UI Test Script step, including reference errors, elements that aren't found, step timeouts, comparison failures, and impersonation failures.

The user API simulates realistic user interactions in a Run UI Test Script step. Each interaction fires the same events a real browser user produces, such as focus, input, change, blur, and keyboard events, so that client scripts and reactive frameworks respond correctly.

Learn how to use the Run UI Test Script step to navigate to records, fill fields, click buttons, impersonate users, upload attachments, and assert UI state on classic and Now Experience pages.

Use the Resource Inventory Open API to create, retrieve, update, and delete resources such as interface cards, logical and physical connections, network sites, and more.

Scoped caches allow customers to store custom data in memory for faster access, and define when it becomes invalidated. This can be useful when working with data takes longer to obtainthat from scratch, such as the results of a query across multiple tables. Use the ScopedCacheManager API to retrieve, set, and flush cache data for scoped applications.

Use the Service Order Open API to create, update, and retrieve service order information.

Use Synthetic Monitoring APIs create multiple synthetic monitors in a single operation.

Use the Trouble Ticket Open API to manage ticket information between external ticketing systems and the ServiceNow AI Platform. This API creates, updates, and retrieves data from the Case [sn_customerservice_case] and Incident [incident] tables.

Resilient automated tests are built by querying components semantically, through ARIA roles and accessible names, rather than relying on implementation details that teams can change at any time.