Approval Gate and Pipeline Step Notification Using Teams Tool

Owned by Christina
Last updated: Sept 09, 2022
4 min read

An Approval Gate step can be added to pipeline in order to obtain approval by selected user before the continuation of steps can occur. In order for this step to function correctly, you must configure a Pipeline Notification using Teams Tool to the Approval Gate pipeline step. The Pipeline Notification will be sent to the configured Teams channel. This documentation outlines how to create an incoming webhook URL in Microsoft Teams, properly configure a Teams Tool, then configure an Approval Gate and Pipeline Notification.

Create an Incoming Webhook in Microsoft Teams Channel

  1. Log into Microsoft Teams and navigate to Teams in the left hand navigation.

  2. Select … from the bottom left navigation bar.

  3. Search for Incoming Webhook and select Add to a team.

  4. Select the channel in which you will receive the notifications.

  5. Click Set up a connector.

  6. Provide a name for the Incoming Webhook and click Create.

  7. Copy the URL below to save it to the clipboard, then select Save. You'll need this URL to configure the Teams tool in Opsera’s Tool Registry. Click Done.

Teams Tool Configuration

  1. Navigate to Tool Registry and select +New Tool.

  2. Locate the Teams tool and click Select Tool.

  3. Provide a Tool Name and click Create.

  4. Navigate to the Connection tab of the newly created tool.

  5. Paste the Microsoft Teams Webhook URL in the provided field.

  6. Click Save.

Approval Gate Pipeline Step Configuration

  1. To add an Approval Gate step, add a new pipeline step in the pipeline Workflow. Select Approval Gate from the Tool drop-down. Click Save and close the step.

2. Click on the gear icon to open Step Settings. Add a Custom Step Message by enabling Send Custom Message toggle (optional) and provide Point of Contact.

3. Click Save then proceed to Pipeline Notifications Configuration.

To complete Approval Gate step configuration you must configure the pipeline notification to the Approval Gate step.

Microsoft Teams Notification Configuration

  1. Click Microsoft Teams from the left hand panel to configure Microsoft Teams Notifications.

  2. Enable the Microsoft Teams toggle.

  3. Provide the following values:

    Notification Level - Select the scenario which you want to be notified from the drop-down. Choose from Step Completed, On Error, or All Activity.
    Teams Tool - Select the correctly configured Teams tool from the drop-down.

     

  4. Click Save. The Microsoft Teams Notification is now configured. Notifications will now be sent to this Teams channel when the selected conditions are met.

Approval via Teams or Opsera UI

Once the above Approval Gate step and pipeline notification has been properly configured and the running pipeline reaches the step, user will receive a notification via the selected Microsoft Teams channel. Approve or Reject either within the channel UI or within the Opsera portal.

Approval via Microsoft Teams

Approval via Opsera

Click Approve button.

Add any comments, enable the Approved toggle, and click Approve button.

You will then receive an Approval Status message verifying that the approval has been received. The pipeline will continue to run.