Configure Callout URL
Last updated
Last updated
The CI JOBS screen is best viewed when the zoom setting is set to 80% on your chrome/firefox browser.
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.
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
Select the Configure Callout URL checkbox under the Callout URL section.
Choose the Callout Type:
Pre-Deployment: ARM will perform the HTTP request before the deployment begins, once the build is successful.
Post-Deployment: By default, ARM will perform the HTTP request after the deployment is completed, regardless of whether it is successful. To run the HTTP request based on whether the deployment is a success or a failure, select the respective option:
On Success
On Failure
The callout URL method is selected as Post by default.
In the URL box, enter the target URL endpoint of the HTTP request.
Select the Authorization type:
Basic: Authenticate the target URL via standard method-username and password
Custom: Authenticate the connection via username: API Token
Please use the “token” keyword in the "Token" field followed by the token value.
OAuth: ARM supports the Client Credentials as a grant type for OAuth 2.0 authentication. To add an OAuth 2.0 provider, fill in the below details:
URL (required): OAuth 2.0 provider URL
Client ID (required): The client ID that your callout service uses to identify the ARM application
Client Secret (required): The client secret that your callout service uses to authenticate the identity of the ARM applicationThe Client Secret field is hidden during your current CI job editing, preventing you from updating the secret key. But you can insert a new secret key (if required).
Access token URL (required): The URL that the client uses to obtain an access token given an authorization code
Scope (optional): Specifies the level of access that the ARM application is requesting
Grant Type (required): The Grant Type is selected as Client Credentials by default
The Content-Type header describes the format in which the body of your request is being sent. For example, the body of your requests can be sent as JSON or XML.
To send JSON in a request, use application/json and add your content in the field provided.
To send XML in a request, use application/xml and add your content in the field provided.
To add a custom header, click on the Add Header button and enter the keys and their value. Multiple adding of keys and values are allowed.
Default headers is set as "Accept" :"application/json", "Content-Type":"application/json"
Click on Save.
| 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 the types of the specified values must match the expected types.
You can view the detailed log report under the Build Log section.
View the detailed log report under the Deployment Log section.
