How to send slack message using ADO YAML Pipeline post successful and failed builds?

Question

I'm trying to send a Slack message to a specified channel post-build, all branch policies are successful, and all status checks pass in a Azure DevOps YAML pipeline. But it seems I am having a few individual issues. This is fairly new to me so any help is appreciated.

Concept:

Post-Build Success, All Branch Policies & Status Checks Pass -> Send Slack Notification to specified channel.
If the build fails or any branch policies fail, Direct Message the Pull Requests Creator.
If any new commits are made to the branch while the pull request is active, or any comments are resolved on the pull request, the pipeline will rerun and follow the same previous steps.

What I Tried:

I tried a bunch of different combination of conditions but they didn't work.
For example, a plain succeeded() and failed() without dependencies, or succeeded('Test') as stage level or succeeded('UnitTest') as job level.
I also attempted having stages to build and restore but that was not necessary at this point in time. 4.In most cases, they send the success message even if they failed, and failed does not send the direct message, and messages that do send do not contain any successful variables.

Problems:

I can't find a proper condition setting to distinguish between success and failures.
I cannot find the Slack User Id as well as other variables to populate the Slack Messages.
Trouble with the message formatting in slack properly
I also am having trouble having this run as a final step only after all branch policies pass - less "At least 1 reviewer must approve." The branch policies are inherited.
Adding condition for Status Checks.

I have included some reference images below as well.

trigger:
  - none  # Disable automatic trigger for commits. Trigger only for PRs.

resources:
  repositories:
    - repository: templates
      type: git
      name: Hagerty/azure-pipelines-templates

pr:
  branches:
    include:
      - main  # Only trigger for PRs targeting 'main'

pool:
  vmImage: 'windows-latest'

variables:
  - group: billing_pr_slack_notification  # ADO variable group

stages:
  - stage: BuildAndNotify
    displayName: 'Billing PR Slack Notifications'
    # Ensure this stage runs only after all PR policies succeed
    condition: and(succeeded(), eq(coalesce(variables['System.PullRequest.IsDraft'], false), false), startsWith(variables['Build.SourceBranch'], 'refs/pull/'))
    jobs:
      - job: LogVariables
        displayName: 'Log Pipeline Variables'
        steps:
          - script: |
              echo '=== Debugging Variables ==='
              echo 'AZURE_DEVOPS_ORG: $(AZURE_DEVOPS_ORG)'
              echo 'AZURE_DEVOPS_PROJECT: $(AZURE_DEVOPS_PROJECT)'
              echo 'SLACK_API_URL: $(SLACK_API_URL)'
              echo 'SLACK_BOT_TOKEN: $(SLACK_BOT_TOKEN)'
              echo 'SLACK_CHANNEL: $(SLACK_CHANNEL)'
              echo 'PRODUCT_BILLING_DEV_WEBHOOK_URL: $(PRODUCT_BILLING_DEV_WEBHOOK_URL)'
              echo 'System.PullRequest.IsDraft: $(System.PullRequest.IsDraft)'
              echo 'System.PullRequest.SourceBranch: $(System.PullRequest.SourceBranch)'
              echo 'System.PullRequest.TargetBranch: $(System.PullRequest.TargetBranch)'
            displayName: 'Output Debugging Variables'

      - job: FetchSlackUserID
        displayName: 'Fetch Slack User ID'
        dependsOn: LogVariables
        steps:
          - powershell: |
              $creatorEmail = $env:BUILD_REQUESTEDFOR
              if (-not $creatorEmail) {
                  Write-Host "##vso[task.logissue type=error]The Build.RequestedFor email is empty. Cannot proceed to fetch Slack User ID."
                  exit 1
              }
              $slackToken = "$env:SLACK_BOT_TOKEN"
              $response = Invoke-RestMethod -Uri "https://slack.com/api/users.lookupByEmail?email=$creatorEmail" -Headers @{Authorization="Bearer $slackToken"}

              if ($response.ok -eq $true -and $response.user.id) {
                  $userId = $response.user.id
                  Write-Host "##vso[task.setvariable variable=userId]$userId"
                  Write-Host "Successfully retrieved Slack User ID: $userId"
                  Write-Host "Debug: Slack User ID is $userId"
              } else {
                  Write-Host "Defaulting to Slack channel $env:SLACK_CHANNEL."
                  Write-Host "##vso[task.setvariable variable=userId]$env:SLACK_CHANNEL"
              }
            displayName: 'Fetch Slack User ID'

      - job: SlackNotification
        displayName: 'Send Slack Notifications'
        dependsOn: FetchSlackUserID
        steps:
          # Send a channel notification only on success
          - powershell: |
              $webhookUrl = "$env:PRODUCT_BILLING_DEV_WEBHOOK_URL"
              $createdBy = $env:SYSTEM_PULLREQUEST_CREATEDBY
              $prTitle = $env:SYSTEM_PULLREQUEST_TITLE
              $prDescription = $env:SYSTEM_PULLREQUEST_DESCRIPTION
              $prUrl = $env:SYSTEM_PULLREQUEST_URL

              # Handle unset variables by providing default values
              if (-not $createdBy) { $createdBy = "Unknown User" }
              if (-not $prTitle) { $prTitle = "Untitled PR" }
              if (-not $prDescription) { $prDescription = "No description provided." }
              if (-not $prUrl) { $prUrl = "No link available." }

              $message = @{
                  text = "<@here> [$createdBy] has created a new Pull Request & is ready for Code Review:
**Title**: $prTitle
**Description**: $prDescription
[View PR]($prUrl)"
              } | ConvertTo-Json -Depth 10

              Invoke-RestMethod -Uri $webhookUrl -Method Post -Body $message -ContentType 'application/json'
              Write-Host "Slack channel notification sent successfully."
            displayName: 'Send Slack Notification'
            condition: and(succeeded(), endsWith(variables['System.PullRequest.TargetBranch'], '/main'))

          # Send a direct message only on failure
          - powershell: |
              $gifUrls = @(
                  "https://media.giphy.com/media/Ju7l5y9osyymQ/giphy.gif",
                  "https://media.giphy.com/media/26AHONQ79FdWZhAI0/giphy.gif",
                  "https://media.giphy.com/media/3o6Zt481isNVuQI1l6/giphy.gif"
              )
              $randomGif = $gifUrls | Get-Random
              $slackToken = "$env:SLACK_BOT_TOKEN"
              $userId = "$env:userId"

              $prTitle = $env:SYSTEM_PULLREQUEST_TITLE
              $prUrl = $env:SYSTEM_PULLREQUEST_URL

              # Handle unset variables by providing default values
              if (-not $prTitle) { $prTitle = "Untitled PR" }
              if (-not $prUrl) { $prUrl = "No link available." }

              $message = if ($env:BUILD_STATUS -eq "Failed") {
                  "Your Pull Request **$prTitle** failed to build. Please review your branch.
[View PR]($prUrl)

![Failure GIF]($randomGif)"
              } else {
                  "Your Pull Request **$prTitle** failed the following policy check: $env:BUILD_DEFINITIONNAME. Please review your branch.
[View PR]($prUrl)

![Failure GIF]($randomGif)"
              }

              $body = @{
                  channel = $userId
                  text    = $message
              } | ConvertTo-Json -Depth 10

              Invoke-RestMethod -Uri "https://slack.com/api/chat.postMessage" -Method Post -Headers @{Authorization="Bearer $slackToken"} -Body $body
              Write-Host "Slack DM sent successfully to user $userId."
            displayName: 'Send Slack DM if Build or Policy Fails'
            condition: failed()

How to send slack message using ADO YAML Pipeline post successful and failed builds?

Answers (1)

Related Questions