Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Service Now

External Approval Workflow Integration with ServiceNow.

Overview

AutoRABIT ARM supports an External Approval Workflow Integration with ServiceNow for CI Jobs, enabling organizations to manage deployment approvals through ServiceNow Change Requests.

This integration allows ARM to automatically or manually create Change Requests based on configured approval rules. For CI Jobs requiring approval, ARM pauses the deployment process until the required approval is received from ServiceNow.

Once approved, ARM automatically resumes the CI Job deployment using the previously prepared package, without rebuilding it.

After deployment, ARM updates the associated ServiceNow Change Request with the execution outcome, improving deployment governance, approval tracking, and auditability.

Availability: New UI only

Supported Module: CI Jobs

Note: This integration is not supported for standalone Deployments.


Prerequisites

Before configuring the ServiceNow External Approval Workflow, ensure that:

  • You have access to AutoRABIT ARM New UI.

  • You have the required permissions to register and configure ALM integrations.

  • You have access to an active ServiceNow instance.

  • You have the necessary ServiceNow permissions to register OAuth applications and manage Change Requests.

  • The ServiceNow account has permission to create and update Change Requests.

  • An authorized ServiceNow administrator is available to configure the webhook required for approval notifications.

  • The required Change Request types and approval states are configured in ServiceNow.


Step 1: Register an OAuth Application in ServiceNow

Before registering ServiceNow in ARM, create an OAuth application in ServiceNow to generate the Client ID and Client Secret.

ARM uses OAuth authentication to establish a secure connection with ServiceNow.

Procedure

  1. Log in to your ServiceNow instance.

  2. Navigate to Application Registry or Inbound Integrations, depending on your ServiceNow interface.

  3. Click New to create an application.

  4. Select OAuth – Authorization code grant.

  5. Enter the required application details.

Field
Description

Name

Enter a name to identify the ARM integration

Provider name

Enter the appropriate provider name

Redirect URLs

Paste the Redirect URL provided by ARM

Client ID

Use the Client ID generated by ServiceNow

Client Secret

Use the generated Client Secret

Active

Ensure the application is active

  1. Configure the required OAuth scope.

  2. Click Save.

  3. Copy the generated Client ID and Client Secret for use in ARM.

Note: The ARM registration example uses the useraccount scope. This scope provides broad access to ServiceNow REST APIs. Confirm the appropriate scope and permissions with your ServiceNow administrator before enabling the integration.

The Redirect URL must match the URL displayed in the ARM registration screen.


Step 2: Register ServiceNow in AutoRABIT ARM

After creating the OAuth application in ServiceNow, register ServiceNow as an ALM integration in ARM.

Procedure

  1. Log in to AutoRABIT ARM using the New UI.

  2. Navigate to Settings → ALM.

  3. Click Register ALM.

  4. Enter the required details.

Field
Description

Name

Enter a unique name for the ServiceNow integration

Type

Select ServiceNow

Access Type

Select OAUTH

URL

Enter your ServiceNow instance URL

Client ID

Enter the Client ID generated in ServiceNow

Client Secret

Enter the Client Secret generated in ServiceNow

Redirect URL

Copy the ARM-generated Redirect URL and configure it in ServiceNow

Scope

Enter the configured OAuth scope

  1. Verify the registration details.

  2. Click Connect to initiate the OAuth authorization process.

  3. ARM redirects you to the ServiceNow authorization page.

  4. Review the requested permissions.

  5. Click Allow to authorize the connection.

  6. Complete the registration process.

Once authorization is successful, ServiceNow is registered as an ALM integration in ARM.

Important: Always use the Redirect URL generated by your ARM instance. The URL shown in the reference screenshots belongs to a development environment and should not be reused in another environment.


Step 3: Configure the ServiceNow Change Request Table

After registering ServiceNow, configure the table ARM will use for creating and managing Change Requests.

Procedure

  1. Navigate to Settings → ALM.

  2. Select the registered ServiceNow integration.

  3. Open the External approval tab.

  4. Select Table configuration.

  5. Click the option to add a table.

  6. In the Add table window, search for Change Request.

  7. Select Change Request (change_request).

  8. Click Add.

  9. Click Done to complete the selection.

The selected table becomes available for configuring the Change Management Gate and Column Configuration.

Note: The Change Request table is recommended for ServiceNow approval workflows.


Step 4: Configure ServiceNow Column Mapping

Column Configuration determines how ARM populates fields when creating ServiceNow Change Requests.

Administrators can map fields using ARM execution information, predefined values, or values provided during Change Request creation.

Procedure

  1. Open the registered ServiceNow integration.

  2. Navigate to External approval → Column configuration.

  3. Select Change Request (change_request) from the Table dropdown.

  4. Review the available ServiceNow fields.

  5. Use the search option to locate a specific field.

  6. Enable the Use toggle for the fields you want ARM to populate.

  7. Under Filled by, select the appropriate value source.

  8. Configure the corresponding Value.

  9. Set the Editable and Required options, where applicable.

  10. Click Save configuration.

Available Field Mapping Options

Option
Description

ARM token

Automatically populates the field using ARM execution information

Fixed value

Uses a predefined value

Asked at deployment

Allows the user to provide a value when creating the Change Request

From the change-type rule

Uses the value defined in the configured Change Type Rule

Available ARM Tokens

ARM provides dynamic tokens that can be used to populate Change Request fields.

These include:

  • {orgName} – Salesforce organization name

  • {projectName} – CI Job or project name

  • {buildNumber} – CI Job build number

  • {correlationKey} – Correlation identifier

  • {triggeredBy} – User who triggered the build

  • {branchName} – Source branch name

  • {repoName} – Repository name

  • {fromRevision} – Starting revision

  • {toRevision} – Ending revision

  • {timeOfBuild} – Build execution time

  • {title} – Title information

  • {plannedStart} – Planned start time

  • {plannedEnd} – Planned end time

  • {buildUrl} – CI Job build URL

  • {armUrl} – ARM application URL

These tokens help populate Change Requests with relevant CI Job information.

For example, the Description field can include the CI Job name, build number, and target Salesforce organization.


Step 5: Enable External Approval and Configure the Change Management Gate

The Change Management Gate determines how ARM creates ServiceNow Change Requests and whether the CI Job deployment must wait for approval.

Procedure

  1. Navigate to Settings → ALM.

  2. Select the registered ServiceNow integration.

  3. Open External approval → Change management gate.

  4. Enable the Enable external approval toggle.

  5. Under Apply to, select CI jobs.

  6. In the Gate table dropdown, select Change Request (change_request).

  7. Configure the required settings.

Setting
Description

ARM callback URL

Endpoint used by ServiceNow to notify ARM about approval status changes

Reminder after (minutes)

Sends a reminder to the user who started the build when approval remains pending for the configured duration

Planned start offset (minutes)

Defines the offset used to calculate the planned deployment start

Planned end offset (minutes)

Defines the offset used to calculate the planned deployment end

  1. Configure the required Change Type Rules.

  2. Click Test connection to verify connectivity.

  3. Click Save changes.

Note: Setting the reminder value to 0 disables approval reminders.


Step 6: Configure Change Type Rules

Change Type Rules determine how ARM handles ServiceNow Change Requests for CI Job deployments.

Administrators can define different rules based on the Change Type.

Procedure

  1. Under Change management gate, locate Change type rules.

  2. Click Add rule.

  3. Select the Change Type.

  4. Configure the Ticket Creation method.

  5. Select the Deployment Action.

  6. Configure the Gate Status and Rejected Status, where applicable.

  7. Enter the Timeout duration.

  8. Select the action ARM should perform when the timeout is reached.

  9. Save the configuration.

Example Configuration

Setting
Standard Change
Normal Change

Change Type

Standard

Normal

Ticket Creation

Automatic

Manual

Deployment Action

Deploy immediately

Wait for approval

Gate Status

Not used

Authorize

Rejected Status

Not used

Closed

Timeout

Not applicable

120 minutes

On Timeout

Not used

Cancel the deployment

The above values are based on the example configuration shown in the screenshots. Administrators can configure the rules according to their organization's requirements.

Standard Change

For Standard Changes, ARM automatically creates a ServiceNow Change Request and proceeds with the CI Job deployment without waiting for additional approval.

The Change Request is created for tracking purposes.

Normal Change

For Normal Changes, ARM creates or allows the user to create a ServiceNow Change Request and pauses the CI Job deployment until the request reaches the configured approval state.

For example, when the Gate Status is configured as Authorize, ARM waits until the Change Request reaches that state.

If approval is not received within the configured timeout, ARM performs the selected timeout action.

In the example configuration, ARM cancels the pending CI Job deployment after 120 minutes.


Step 7: Configure the ARM Approval Callback in ServiceNow

The ARM callback URL enables ServiceNow to notify ARM when a Change Request reaches the configured approval state.

This notification allows ARM to automatically resume the CI Job deployment.

Procedure

  1. Navigate to Settings → ALM → External approval → Change management gate.

  2. Locate the ARM callback URL field.

  3. Click the copy icon to copy the generated URL.

  4. Log in to ServiceNow with the required administrative permissions.

  5. Configure an outbound notification rule or webhook for the Change Request table.

  6. Configure the notification condition to trigger when the Change Request reaches the required approval state.

  7. Enter the ARM callback URL as the destination.

  8. Configure the required authentication.

  9. Save and activate the ServiceNow notification configuration.

  10. Test the integration using a Change Request.

Webhook Authentication

The ARM configuration screen specifies that the notification rule must authenticate using a webhook token generated from API Token Manager.

Use Basic Authentication with:

  • Username: ARM login name

  • Password: Webhook token generated from API Token Manager

Ensure that the webhook is configured to notify ARM whenever the Change Request reaches the approval state specified in the Change Type Rule.

For example, if the Gate Status is configured as Authorize, ServiceNow must notify ARM when the Change Request reaches that state.

Important: The exact ServiceNow outbound notification configuration and webhook request payload are not shown in the provided screenshots. Work with your ServiceNow administrator and refer to the supported ARM webhook configuration details to complete this setup.


Step 8: Configure Post-Deployment Updates

ARM can update the associated ServiceNow Change Request after the CI Job deployment completes.

Procedure

  1. Navigate to External approval → Change management gate.

  2. Scroll to the After the deployment section.

  3. Configure the following fields:

Field
Description

Work notes

Information ARM adds to the ServiceNow Change Request after deployment

Close notes

Summary of the CI Job deployment outcome

Then move it to

ServiceNow state to which ARM should move the Change Request after deployment

  1. Enter the required Work Notes and Close Notes.

  2. Select the appropriate completion state.

  3. Click Save changes.

Available Dynamic Values

ARM supports dynamic values such as:

  • ${projectName}

  • ${buildNumber}

  • ${deployOutcome}

  • ${deployStatus}

  • ${deployedOrg}

  • ${recordNumber}

  • ${buildUrl}

These values can be used to populate the ServiceNow Change Request with the CI Job deployment results.

Important: ServiceNow may enforce specific Change Request state transitions. If the configured completion state is not allowed by the ServiceNow change model, the state update may fail even when the CI Job deployment has completed.


Step 9: Configure ServiceNow External Approval in a CI Job

Once the ServiceNow integration is enabled, users can configure CI Jobs to use the external approval workflow.

Procedure

  1. Navigate to CI Jobs.

  2. Create a new CI Job or open an existing CI Job configuration.

  3. Complete the required Build configuration.

  4. Navigate to the Deploy step.

  5. Select the Destination Org.

  6. Under Approval system, select the registered ServiceNow integration.

  7. Under Change type, select the required Change Type, such as Normal or Standard.

  8. Configure the remaining deployment settings.

  9. Save the CI Job.

When External Approval is active, ARM displays an informational message indicating that the CI Job uses the configured ServiceNow approval workflow.

For a Normal Change, the CI Job deployment waits for ServiceNow approval before proceeding.

Note: Validation-only CI Job builds do not create ServiceNow Change Requests. The external approval workflow applies to CI Job executions that perform deployments.


Step 10: Execute the CI Job and Create a Change Request

When a CI Job configured with a Normal Change approval workflow is executed, ARM completes the build and pauses before deployment.

Procedure

  1. Navigate to CI Jobs.

  2. Trigger the configured CI Job.

  3. Wait for the build process to complete.

  4. Navigate to CI Job History.

  5. Locate the corresponding execution.

  6. Under Deployment Details, review the Status/Log.

ARM displays the status:

Waiting for External Approval

This indicates that the CI Job deployment is waiting for the required ServiceNow approval.

Manual Change Request Creation

If the Change Type Rule is configured for Manual ticket creation:

  1. Open the Change management details from CI Job History.

  2. Review the Change Request information.

  3. Click Create change request.

  4. ARM creates the Change Request in ServiceNow.

  5. The Request ID and Request Status become available in ARM.

Change Management Details

The Change Management screen displays information such as:

  • Request ID

  • Request Name

  • Request Type

  • Request Status

  • Build Number

  • Approval System

  • Target Organization

  • Requested By

  • Waiting Duration

  • Timeout Information

Users can review these details to track the approval process.


Step 11: Approve the Change Request in ServiceNow

Once the Change Request is created, the designated approver must complete the approval process in ServiceNow.

Procedure

  1. Log in to ServiceNow.

  2. Navigate to Change Management.

  3. Open the Change Request associated with the ARM CI Job.

  4. Review the Change Request details.

  5. Select the appropriate Assignment Group and Approver.

  6. Click Request Approval, where applicable.

  7. The designated approver receives an approval notification.

  8. Open the approval notification.

  9. Review and approve the Change Request in ServiceNow.

In the demonstrated workflow, the Change Request progresses to the Authorize state after approval.

Once the Change Request reaches the configured Gate Status, ServiceNow sends an approval notification to ARM through the configured webhook.


Step 12: Automatically Resume the CI Job Deployment After Approval

Once ServiceNow confirms the required approval, ARM automatically resumes the pending CI Job deployment.

Expected Behavior

  1. ServiceNow updates the Change Request to the configured approval state.

  2. The configured webhook sends the approval notification to ARM.

  3. ARM validates the approval information.

  4. ARM updates the Change Management status.

  5. The CI Job deployment is released from the waiting state.

  6. ARM resumes deployment using the previously prepared package.

  7. The CI Job continues with any configured post-deployment activities.

ARM displays the Change Request status as:

Approved in ServiceNow

Approval Tracking

The Change Management details display information such as:

  • Request ID

  • Request Status

  • Approval System

  • Released By

  • Released On Status

  • Released At

  • Waiting Duration

For webhook-based approvals, the Released By field identifies ServiceNow as the approval source.

Note: ARM does not rebuild the deployment package after approval. The pending CI Job deployment resumes using the existing package.


Step 13: Review CI Job Execution Logs

Users can review the CI Job execution logs to track the complete approval and deployment process.

Procedure

  1. Navigate to CI Jobs → CI Job History.

  2. Open the relevant CI Job execution.

  3. Select Status/Log.

  4. Review the execution messages.

The logs provide information about:

  • CI Job build completion

  • ServiceNow Change Request creation

  • Waiting for external approval

  • Approval received from ServiceNow

  • CI Job deployment resumption

  • Deployment execution results

  • ServiceNow Change Request update results

This helps users track the approval and deployment process from a single CI Job execution.


Step 14: Review Deployment Results in ServiceNow

After the CI Job deployment completes, ARM attempts to update the associated ServiceNow Change Request with the execution outcome.

Procedure

  1. Log in to ServiceNow.

  2. Navigate to Change Management.

  3. Open the Change Request associated with the CI Job execution.

  4. Review the Work Notes or activity details.

  5. Verify the deployment information updated by ARM.

Depending on the configured field mappings, the information may include:

  • CI Job name

  • Build number

  • Target Salesforce organization

  • Deployment status

  • Deployment outcome

  • Link to the corresponding ARM execution

ARM also attempts to move the Change Request to the configured completion state.

Handling ServiceNow State Transition Errors

In some cases, ServiceNow may reject a direct transition to the configured completion state.

For example, the ServiceNow change model may require the Change Request to progress through intermediate states before reaching Closed.

If the state transition fails:

  1. Review the CI Job execution logs in ARM.

  2. Identify the ServiceNow error message.

  3. Verify the allowed state transitions in ServiceNow.

  4. Review the configured completion state under After the deployment.

  5. Update the configuration as required.

A failure to update the ServiceNow Change Request does not necessarily indicate that the Salesforce deployment failed. Review the deployment result and ServiceNow update status separately.


Frequently Asked Questions

Q1. Is the ServiceNow External Approval Workflow available for both CI Jobs and Deployments?

No. The integration is supported only for CI Jobs in the New UI. Standalone Deployments are not supported.

Q2. Does ARM support OAuth authentication for ServiceNow?

Yes. ARM supports OAuth authentication using a Client ID and Client Secret generated in ServiceNow.

Q3. Can ARM automatically create ServiceNow Change Requests?

Yes. ARM supports automatic and manual Change Request creation based on the configured Change Type Rules.

Q4. What is the difference between Standard and Normal Changes?

Standard Changes can proceed without waiting for additional approval, while Normal Changes can be configured to wait until the required ServiceNow approval is received.

Q5. What happens when a CI Job requires ServiceNow approval?

ARM completes the build and places the deployment process in the Waiting for External Approval state until the required approval is received.

Q6. Is a webhook required for automatic approval processing?

Yes. The demonstrated integration uses a ServiceNow webhook to notify ARM when the Change Request reaches the configured approval state.

Q7. Does ARM rebuild the package after ServiceNow approval?

No. ARM resumes the CI Job deployment using the previously prepared package.

Q8. What happens if approval is not received within the configured timeout?

ARM performs the configured timeout action, such as cancelling the pending CI Job deployment.

Q9. Can users track the ServiceNow Change Request from ARM?

Yes. ARM displays the Request ID, Request Status, approval information, and associated CI Job execution details.

Q10. What happens if the CI Job deployment fails?

ARM records the deployment failure and attempts to update the associated ServiceNow Change Request with the execution outcome.

Q11. What happens if ServiceNow rejects the Change Request closure?

ARM records the error in the CI Job execution logs. Administrators should review the configured completion state and the ServiceNow change model.

Q12. Will existing CI Job post-deployment activities continue after approval?

Yes. Once approval is received, ARM resumes the CI Job deployment, and configured post-deployment activities continue according to the existing CI Job settings.


Summary

The External Approval Workflow Integration with ServiceNow enables organizations to manage CI Job deployment approvals through their established ServiceNow change management processes.

The integration supports OAuth-based authentication, configurable Change Request creation, field mapping, approval-based CI Job deployment execution, webhook-driven approval notifications, and execution result synchronization.

By integrating ServiceNow approvals directly into CI Job workflows, ARM helps organizations improve deployment governance, maintain approval traceability, and reduce manual coordination.

This enhancement is available exclusively for CI Jobs in the AutoRABIT New UI and does not apply to standalone Deployments.

Last updated

Was this helpful?