API Reference | ServiceNow SDK

📄️Acl

Creates an Access Control List (ACL) record that secures parts of an application (syssecurityacl).

📄️AiAgent

Configure an AI Agent record. AI Agents are intelligent agents that execute tools,

📄️AiAgenticWorkflow

Configure an AI Agentic Workflow record. AI Agentic Workflows orchestrate multiple

Creates a Connection & Credential Alias (sysalias) — a named handle that integrations, Flow Designer actions, and scripts use to reference a connection and credential pair without hard-coding instance-specific values. Reference fields like configurationTemplate, retryPolicy, and parent accept a sysid string, a Record reference, or the corresponding Fluent call (AliasTemplate(), RetryPolicy(), Alias()) directly.

📄️AliasTemplate

Creates a Connection & Credential alias template (sysaliastemplates): a reusable

📄️ApplicationMenu

Creates an Application Menu (sysappapplication). Application menus define top-level sections in the ServiceNow navigator sidebar. Modules define the clickable items within them.

📄️BusinessRule

Creates a Business Rule: logic that runs when database records are queried, updated,

📄️ChoiceSet

Adds choices to a table field by creating a syschoiceset record. Use this API when the field is not owned by the current app — for example, a globally-defined field on an app-scoped table that extends a global table. For fields owned by the current app, define choices inline in the Table API instead.

📄️ClientScript

Creates a Client Script (sysscriptclient) that runs JavaScript in the browser on form events (onLoad, onChange, onSubmit, onCellEdit) to dynamically configure forms, fields, and field values.

📄️CrossScopePrivilege

Creates a Cross Scope Privilege — a declaration that your application needs runtime access to resources owned by a different application scope (sysscopeprivilege). Required when your scripts read/write tables, call script includes, or use scriptable objects from other scopes.

📄️DataLookup

Creates a Data Lookup definition (dl_definition) that automatically copies field

📄️DataPolicy

Creates a Data Policy that enforces field mandatory and read-only rules server-side across all interfaces

📄️EmailNotification

Creates an email notification configuration for ServiceNow. Email notifications are automated messages

🗃Flow

8 items

📄️Form

Creates a form definition (sysuiform) for a ServiceNow table with sections and layout blocks.

📄️ImportSet

Creates an Import Set: defines how rows in a staging/source table are transformed and loaded into a target table (systransformmap).

📄️InboundEmailAction

Configure an Inbound Email Action record. Inbound email actions define how ServiceNow

🗃Instance Scan

4 items

📄️List

Creates a list layout for a table (sysuilist) with column definitions (sysuilist_element).

📄️NowAssistSkillConfig

Branding note: "Now Assist" has been rebranded to "ServiceNow Otto." These names refer to the same product. All technical identifiers (table names, field names, string literals like "Now Assist Panel", nowassistdeployment) remain unchanged — use them exactly as-is in code.

📄️PlaybookDefinition

Creates a ServiceNow Playbook: a guided multi-step process that operates on a record (syspdprocess_definition). Composed of lanes, activities, triggers, inputs, and outputs with inline startRule ordering.

📄️Property

Creates a System Property -- a key-value configuration setting read at runtime via gs.getProperty() (sys_properties). Properties allow admins to tune application behavior without code changes.

📄️Record

Create a record in any table. This is a low-level function typically used as

📄️RestApi

Creates endpoints, query parameters, and headers for a scripted REST service (syswsdefinition).

📄️RestMessage

Creates outbound HTTP integrations (sysrestmessage) with a base URL, shared authentication, shared headers, and one or more callable HTTP method functions (sysrestmessagefn) invokable from server-side scripts via snws.RESTMessageV2.

📄️RetryPolicy

Creates a Retry Policy record (sysretrypolicy) that controls how outbound integration connections handle transient failures. A retry policy defines the strategy, attempt count, wait interval, maximum elapsed time, and the conditions under which retries apply.

📄️Role

Creates a Role -- a named permission that can be assigned to users and groups to control access to application features, data, and APIs (sysuserrole). Roles are referenced by ACLs, UI Actions, and other access-controlled entities.

📄️ScheduledScript

Creates a Scheduled Script Execution: a server-side script that runs automatically

📄️ScriptAction

Script Actions are used to execute server-side scripts when specific events occur.

📄️ScriptInclude

Script includes are used to store JavaScript that runs on the server.

🗃Service Catalog

6 items

🗃Service Portal

9 items

📄️Sla

Creates an SLA definition (contract_sla): a timer that tracks service commitments

📄️StateModel

Creates a State Model that defines states, transitions, and gating conditions for a table. A single StateModel() call produces the model record plus all of its state, transition, and condition records. The plugin auto-detects the model table from the target table (changerequest → chgmodel, problem → prbmodel, problemtask → prbtaskmodel, any other table → the base sttrm_model).

🗃Table

2 items

📄️Test

Creates an Automated Test Framework test (sysatftest).

📄️UiAction

Creates a UI Action — a button, link, or context menu item that executes server-side or client-side logic on forms and lists (sysuiaction). UI Actions appear as buttons on forms, options in context menus, or links in related lists.

📄️UiPage

Creates a UI Page — a standalone web page accessible via a .do endpoint that can contain HTML, CSS, client scripts, and processing scripts (sysuipage). UI Pages support both traditional Jelly/HTML content and modern React-based single-page applications.