Setup Examples

1 min read

Setup Examples #

Overview

Every setup follows the same order: create the channel, attach it to a trigger with recipients, then confirm delivery in the log.

1. Slack Alert When a Pipeline Needs Approval (Global Event) #

  1. 1

    Create the channel. Go to Channels and click Add Channel. Name it Release-Approvals Slack, set the Channel Type to SLACK (the Job Step becomes SLACK_NOTIFY), add a credential and proxy only if needed, and click Add. Make sure its toggle is on.

  2. 2

    Open the event. On the Events page, open the three-dot menu of Pipeline Approval, select Manage Channels, and click Add Channel.

  3. 3

    Step 1, Select Channel. Channel type Slack, Select Channel Release-Approvals Slack. Keep Enable channel on, and click Next.

  4. 4

    Step 2, Notification Template. Keep Default Template with pipeline_approval_slack, and click Next.

  5. 5

    Step 3, Send Notification to. Tick Channel, and enter the Channel Name #release-approvals and the Slack incoming-webhook URL. Tick In context user(s) too if approvers should also be notified. Click Submit.

  6. 6

    Set the retries (optional). Open the event menu, select Manage Re-Attempts, adjust the delays, and click Save Details.

  7. 7

    Check that the event is on. The Pipeline Approval toggle must be on, and the Slack icon now shows under Channel Configured.

  8. 8

    Verify. Trigger a pipeline with an approval stage. Open Manage Notifications → Global Events, filter by Event = Pipeline Approval, and check the Status column.

2. Email the Team When a Pipeline Fails (Pipeline Rule) #

  1. 1

    Check that an Email channel exists (for example Email notify) and is turned on.

  2. 2

    Open the rules of the pipeline: pipeline card three-dot menu → Edit Pipeline → bell icon → Add Rule.

  3. 3

    Basic Info. Rule Name nightly-failure-alert. Keep Enable Rule on, and click Continue.

  4. 4

    Event Type. Select Pipeline Failure, and click Next. For stage or job events, tick the stages or jobs in the scope step.

  5. 5

    Channels & Templates. Select Email notify. Expand its panel and keep Pre-baked Template → Pipeline Email Notification (Complete). Enter the DL Name platform-team and the DL Email platform-team@yourcompany.com, and click Next.

  6. 6

    Re-Attempt Details. Keep or change the delays, and click Next.

  7. 7

    Overview. Check the summary and click Save Rule. The rule appears in the list with its toggle on.

  8. 8

    Verify. After the next failed run, open Manage Notifications → Pipeline Events and filter by Pipeline or Rule Name. You can also use the run’s three-dot menu → Notification History.

3. If a Message Does Not Arrive #

In Manage Notifications, find the row and open the three-dot menu → View Logs to see the delivery error. Fix the cause (webhook URL, DL email, credential or proxy). Then click Resend, or select several rows and use the bulk Resend.

  #