Start Pipeline API Endpoint

OPL-3035 - Getting issue details... STATUS

The following documentation explains how to use an API call with Opsera’s new API endpoint to trigger a pipeline start with an Approval Gate step. The Approval Gate must be set up with a Step Notification configured to a MS Teams tool. This way you can approve the pipeline start through MS Teams.

Prerequisites: To make an external API request to start a pipeline and approve through MS Teams, you must have a configured MS Teams tool. You must also generate a Personal Access Token with Scope = API Access. For instructions on generating a Personal Access Token, view the https://opsera.atlassian.net/l/c/fSKfvcec documentation.

Pipeline Step Setup

Approval Gate Step

You must use an Approval Gate step for this step. This step must be the FIRST step in the pipeline workflow. Use the following instructions to set up an Approval Gate Step.

1. In pipeline workflow, create a new step.

2. In Step Setup, select Approval Gate from the Tool dropdown.

   

3. Click the ‘Save' button and exit Step Setup.

4. Select the gear icon to configure the Approval Gate step.

   

5. In the Step Configuration form, enable the Send Custom Message toggle. Provide a Custom Step Message and Point of Contact.
   
   Note: The Custom Step Message will be overwritten by the API call Notification Message.
   

   

6. Click the ‘Save’ button and close out of the step.
   

Step Notification Setup

1. Once the Approval Gate step has been configured, click the mail icon on the step to open the Pipeline Step Notification Configuration.

   

2. Select Microsoft Teams.

3. Enable the Teams Notification toggle.

4. Select Notification Level from dropdown.

5. Select the configured Teams Tool from the dropdown.

   

6. Click the ‘Save’ button and exit.

Retrieving Pipeline ID and Step ID for API Request

1. Your Pipeline ID can be found in various locations, such as in the URL of your pipeline or the Summary panel.

   

2. The Step ID from the Approval Gate Step can be found directly on the pipeline step.

   

Now that you have a Personal Access Token, Approval Gate Step, Pipeline ID and Step ID, you can make the API call.

API Request

Use the following information for method, URL, endpoint and body. Verify that the user making the API call has RBAC to the specific pipeline.

{
    "pipelineId":"[insert pipeline id]",
    "stepId": "[insert step id]",
    "notificationMessage":"here is the custom message"
}

Approve Pipeline Start in MS Teams

1. Once you receive the Pipeline Notification via MS Teams, verify the information and click the ‘Approve’ button.

   

2. Once you approve the Pipeline Notification, the pipeline will start.