HTTP Callout Configuration

The CI Jobs screen is best viewed when the zoom setting is set to 80% on your Chrome/Firefox browser.

Overview

The callout URL lets you call another service from the ARM application via an HTTP request. For an HTTP callout to work correctly, all the HTTP callout parameters and the entities associated with the callout must be configured correctly.

Where Can I Find the Configure Callout URL option?

A new section, i.e., Callout URL, is available for the following CI jobs:

• Deploy from Salesforce org

• Deploy from Salesforce org with a version control backup

• Deploy from version control

• Deploy Salesforce-DX (SFDX) source from version control

• Install an unlocked package from a version control branch

Configuring Callout URL

1. Select the Configure Callout URL checkbox under the Callout URL section.

2. Choose the Callout Type:

   • Pre-Deployment: ARM performs the HTTP request before the deployment starts (after a successful build).

   • Post-Deployment: By default, ARM performs the HTTP request after the deployment completes. You can further specify:

     • On Success

     • On Failure

1. The callout method defaults to POST.

2. Enter the endpoint in the URL field.

3. Select an Authorization type:

   • Basic: Standard username and password.

• Custom: Uses username: API Token. Prefix the token with the keyword token.

• OAuth: Supports Client Credentials grant type. Required fields:

  • URL (OAuth 2.0 provider)

  • Client ID

  • Client Secret (hidden when editing an existing CI job)

  • Access Token URL

  • Scope (optional)

  • Grant Type: Defaults to Client Credentials

1. The Content-Type header defines the request body format (e.g., JSON or XML):

   • Use application/json for JSON requests.

   • Use application/xml for XML requests.

1. To add custom headers, click Add Header and define key-value pairs. You can add multiple.

   • Default headers include: "Accept": "application/json", "Content-Type": "application/json"

1. Click Save.

Dynamic Parameters

Parameter	Description
{projectName}	Name of your CI Job
{buildNumber}	Build Number of your CI Job
{sforgName}	Name of your Salesforce Org

Note: You must specify values for dynamic parameters before executing the query, and their types must match expected formats.

Viewing the Log Report

Callout Type: Pre-Deployment

View detailed logs under the Build Log section.

Callout Type: Post-Deployment

Logs are available under the Deployment Log section.