Approval Job

Introduction

The crucial tasks that require a manual review to proceed further can be defined as an approval job in the pipeline. The steps defined in the approval job are usually a set of validations required before a deployment runs. When an approval job is configured, the pipeline execution pauses until the approver approves the job.

The approver will be sent an email notification to approve the job. They can also approve it from the console directly. Learn more about approving a job from the console in this help section.

You can define the approval jobs for the pipeline as key-value pairs using the approve key.

Properties of an Approval Job

Key	Value	is Mandatory
type	This key contains the sub-key type-name.	Yes
type-name	Specify this value as "approval".	Yes
type-variables	This key contains the sub-keys reviewers and message.	Yes
reviewers	Specify the email addresses of the reviewers who can approve this job.	Yes
message	Provide the message that has to be sent to the approver.	Yes

Note:

You can add only a single reviewer for the approval job.
The approval job has no specific timeout, meaning the pipeline execution will remain paused until the approver takes action.

YAML Code Snippet for Approval Job

Here’s an example code snippet for an approval job:

    
        copy
        
            
        
    
    
         approve:
    type:
      type-name: approval
      type-variables:
        reviewers:
          - amelia.b@zylker.com
        message: Review this

Last Updated 2025-05-30 16:54:59 +0530 +0530

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit

Configure the Pipeline