Callout Task

A Callout task is used to invoke a third-party REST API from within ReleaseOwl. Upon selecting this task type, the following configuration screen is displayed:

Fill in the required details:

Name	Enter a valid name for the approval task. Note: Only letters, numbers, underscores (_), and periods (.) are permitted.
Callouts	Choose the required callout from the drop down.
Config Params	Parameters specified in the Payload JSON can be passed during run-time through the Config Params option.
Pipeline Execution	Continue on Failure – If selected, the Release Pipeline Execution will continue even if the callout fails. If the option is left unchecked, then the pipeline execution fails if it encounters any error in calling out the external API. Wait on Task – If selected, then approval task will be created after the callout execution even if callout fails or succeeds. Users can open the task and retry callout execution in case of callout failure. If the option is left unchecked, it will act as a normal web service call which calls out external API and continues based on the response of the external API. User – The approver (user) can be selected from the available list of users for approving the pending task in order to complete the Release Pipeline execution when Wait on Task option is chosen. Role - The pending task can be approved by any user with the user role that is selected in order to complete the Release Pipeline execution when Wait on Task option is chosen.
Description	Any message that is to be conveyed to the task approver can be mentioned here.
Assign Variables	This allows you to store values returned from the external system (like from a JSON response) into pipeline variables.

On clicking the Config Params button, the following screen is displayed. Enter the variable parameter names specified in the Payload JSON along with their values that are to be passed run-time during the execution of the Release Pipeline and save the changes.

System Defined Parameters for a Callout Task - Generic

Below are the variables available for using as values in the configure parameters for a callout Task.

${jobins.jobCycleName}	Cycle name given while triggering the Release Pipeline.
${jobins.instantiatedBy}	Email ID of the person who triggered the Release Pipeline
${jobins.label}	Release Pipeline Name
${jobins.status}	Status of the instance/cycle
${jobins.endTime}	End time when instance is completed. (YYYY-MM-DDTHH24:MM:SS.000+0000)
${jobins.createTime}	Represents the time when instance was created. (YYYY-MM-DDTHH24:MM:SS.000+0000)
${jobins.startTime}	Represents the time when instance was started (YYYY-MM-DDTHH24:MM:SS.000+0000)

System Defined Parameters specific to the Release Pipelines of type SAP BTP

${jobins.inputs.buildJobName}	Name of the build pipeline used as an input for the Release Pipeline.
${jobins.inputs.buildNumber}	Build number of the build pipeline (given as input in the Release pipeline), artifact is used for deploying in the Release Pipeline.