Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Continuous Integration and Continuous Delivery (CICD) Spoke

Build a Continuous Integration and Continuation Delivery (CICD) pipeline for your ServiceNow instances. You can automate publishing and installing applications from an application repository, activating plugins, running ATF test suites, and running an instance scan.

CICD spoke application

The CICD spoke application is installed by default from the Orlando upgrade onward.

Spoke version

Continuous Integration and Continuous Delivery (CICD) spoke v1.0.11 is the latest version.

Supported versions

Continuous Integration and Continuous Delivery (CICD) REST API version 1.0.0, which is a ServiceNow AI Platform feature active by default.

Spoke flows

This spoke has no sample flows.

Spoke subflows

The Continuous Integration and Continuous Delivery (CICD) spoke provides sample subflows in the draft state to demonstrate automating CICD tasks. To customize a sample subflow, copy it to a new application scope. Available sample subflows include:

SubflowDescription
Activate PluginActivate a plugin by ID on the specified instance URL.
Apply Changes From Source Control With IDApply remote changes from source control to an application by its Sys ID.
Apply Changes From Source Control With ScopeApply remote changes from source control to an application by its scope name.
ATF Suite Start With IDStart a test suite by its Sys ID on the specified instance URL. Return the test suite execution results.
ATF Suite Start With NameStart a test suite by its name on the specified instance URL. Return the test suite execution results.
Batch InstallGiven a Batch Plan in JSON format, install multiple packages \(applications, customizations to store applications, and plugins\) together in a single batch operation. Example JSON:
{
  "applications": [
    {
      "id": "syd_id_abcefghi",
      "type": "application",
      "load_demo_data": false,
      "requested_version": "1.0.2",
      "notes": "User specific text to describe this application install"
    },
    { 
      "id": "syd_id_defabcde",
      "type": "application",
      "requested_version": "1.0.0",
      "requested_customization_version": "2.0.7",
      "notes": "Customization for CSM App1"
    },
    {
      "id": "com.glide.some.plugin",
      "type": "plugin",
      "load_demo_data": true,
      "notes": "Plugin related notes"
    }
  ],
  "rollback_on_failure": true
}
Batch ResultsGiven the sys\_id of a result object, view the installation status of each package along with entire batch plan.
Batch RollbackWith a rollback ID, roll back the installation\(s\) of package\(s\) installed as a single batch.
Get Instance Scan ResultsReturn Instance Scan execution results by progress ID. Scan\_results always return but scan\_finding results display only if present.
Import Application from Source ControlImport Application from Source Control using repository URL on the given instance.
Instance Scan Execute Full ScanStart full Instance Scan on specified instance URL. Scan runs with all active checks.
Instance Scan Execute Point ScanStart Instance Scan on specified instance starting from a particular table and record \(the table and sys\_ID\). Target is scanned using all relevant and applicable checks.
Instance Scan Execute Suite ScanStart full Instance Scan on specified instance URL using a specific suite of checks.
Instance Scan Execute Suite Scan on one or more scoped appsStart Instance Scan on specified scoped apps using checks from a specified suite ID.
Instance Scan Execute Suite Scan on one or more update setsStart Instance Scan on the specified update sets using checks from a specified suite ID.
Install Application With IDInstall an application by its Sys ID from the application repository.
Install Application With ScopeInstall an application by its scope name from the application repository.
Publish Application With IDPublish an application by its Sys ID to the application repository.
Publish Application With ScopePublish an application by its scope name to the application repository.
Rollback Application With IDRoll back an application by its Sys ID. Confirm the rollback version number matches the specified version number or produce an error.
Rollback Application With ScopeRoll back an application by its scope name. Confirm the rollback version number matches the specified version number or produce an error.
Rollback PluginRoll back a plugin by ID on the specified instance URL to the last installed version.
Wait Until Tracker CompletesWait for a tracker to complete its progress on the specified instance URL and return the results.

Spoke actions

The Continuous Integration and Continuous Delivery (CICD) spoke provides actions to automate CICD tasks when events occurs in the ServiceNow AI Platform. Available actions include:

CategoryActionDescription
Application RepoInstall Application With IDInstall an application by its Sys ID from the application repository.
Install Application With ScopeInstall an application by its scope name from the application repository.
Publish Application With IDPublish an application by its Sys ID to the application repository.
Publish Application With ScopePublish an application by its scope name to the application repository.
Rollback Application With IDRollback an application by its Sys ID. Confirm the rollback version number matches the specified version number or produce an error.
Rollback Application With ScopeRoll back an application by its scope name. Confirm the rollback version number matches the specified version number or produce an error.
ATFATF Get Suite ResultsReturn the test suite execution results by Sys ID.
Get Execution Tracker ProgressReturn tracker progress information by Sys ID.
Start ATF Suite With IDStart a test suite by its Sys ID on the specified instance URL.
Start ATF Suite With NameStart a test suite by its name on the specified instance URL.
Batch InstallBatch InstallInstall multiple applications at once
Batch ResultsView installation status of each package along with entire batch plan.
Batch RollbackWith a rollback ID, roll back the installation(s) of package(s) installed as a single batch.
Instance ScanGet Instance Scan ResultsReturn Instance Scan execution results by progress ID. Scan_results always display but scan_finding results display only if present.
Instance Scan Execute Full ScanReturn Instance Scan execution results by progress ID. Scan_results always return but scan_finding results display only if present.
Instance Scan Execute Point ScanStart full Instance Scan on specified instance URL. Scan runs with all active checks.
Instance Scan Execute Suite ScanStart Instance Scan on specified instance starting from a particular table and record (the table and sys_ID). Target is scanned using all relevant and applicable checks.
Instance Scan Execute Suite Scan on one or more scoped appsStart full Instance Scan on specified instance URL using a specific suite of checks.
Instance Scan Execute Suite Scan on one or more update setsStart Instance Scan on specified scoped apps using checks from a specified suite ID.
PluginActivate PluginActivate a plugin by ID on the specified instance URL.
Rollback PluginRollback a plugin by ID on the specified instance URL to the last installed version.
Source ControlApply Changes From Source Control With IDApply remote changes from source control to an application by its Sys ID.
Apply Changes From Source Control With ScopeApply remote changes from source control to an application by its scope name.
Import Application from Source ControlImport Application from Source Control using repository URL on the given instance.

CICD account requirements

The Continuous Integration and Continuous Delivery (CICD) spoke requires creating basic authorization credentials. The user credentials must have either the admin or sn_cicd.sys_ci_automation roles to authorize CICD actions and flows.

Connection and credential alias requirements

Integration Hub uses aliases to manage connection and credential information, and OAuth credentials. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection.

This spoke uses the CICD alias record to authorize actions on local and remote instances. For information about setting up the spoke, see Set up the Continuous Integration and Continuous Delivery (CICD) spoke.

MID Server requirements

These actions use REST calls, which can run on an instance or MID Server. Use the connection record associated with the CICD alias to configure where actions run as well as set MID Server selection attributes. For more information, see MID server.

To set up the MID Server for this spoke, see Set up MID Server for a spoke.