When a Github Actions workflow fails, can I notify multiple recipients via email?

[abhi12ravi]

Select Topic Area

Question

Body

By default, only the person who triggers the workflow or the person setting up the workflow gets an email notification on job failure.

Docs: https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs

There is a workaround by adding an extra step (listed below) in the workflow, it claims to send the notification to multiple recipients, but this requires me to store my email username and password as a secret on GitHub, which I don't prefer to do.

Extra step: https://stackoverflow.com/questions/62304258/github-actions-notifications-on-workflow-failure/67265461#67265461

I have to send the failure notification to my team of 4. Any ideas on tackling this problem would be appreciated!

[sunitaguptavertex]

I have similar requirement. Were you able to solve this issue?

[karna41317]

Any updates on this ?

[cywier]

I need this too.

[fabiobsantosprogrow]

This feature was required even nowadays!
Notification settings an option to put all teams or manage this on repo settings.
This information is very importante to leads and devops teams to solve issues and track activity.

[tt-rkim]

+1, multiple people work on pipelines

[Keshapally]

+1 waiting for any solutions from GitHub

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬

[joshjohanning]

By default, GitHub Actions notifies the actor (person who initiated the run) - assuming they haven't tweaked their notification settings. A user can opt in / out of these Action failure notifications.

You can use an Action from the GitHub Actions marketplace, but you would need SMTP credentials: https://github.com/marketplace?type=actions&query=email

There are cloud services, like Mailgun or Sendgrid, that you can also use to facilitate email sending.

---

You can also set up Teams or Slack integration to post to a channel the results of a job. This is how I most commonly see it at customers.

---

As another workaround option, you can create a new issue / issue comment / comment to a PR and @mention the team you want to mention, and provide a link to the workflow that is failing. Something like this:

Like this:

  - uses: actions/create-github-app-token@v1
    id: app-token
    with:
      app-id: ${{ vars.APP_ID }}
      private-key: ${{ secrets.PRIVATE_KEY }}

- name: create issue comment with failure
  run: | 
     # update 123 with the issue number you are commenting to
     gh issue comment 123 -R my-org/my-repo --body "@myorg/myteam: ***Workflow failure*** [View workflow run for details](${{ github.repository.html_url }}/actions/runs/${{ github.run_id}})"
  env:
    GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}

You do have to use a GitHub app or personal access token to @ mention a team though (the ${{ github.token }} will not work).

[jonahgreenthal]

@joshjohanning This is such a common use case (notifying a team rather than one specific person) that it should be supported "out of the box" rather than relying on community extensions that are relatively intensive to set up.

[joshjohanning]

I did edit my commend above to show how you could post a comment to an issue that would tag a team.

I agree it is additional legwork, but that is the only option right now.

[joshjohanning]

You can also set up Teams or Slack integration @jonahgreenthal to post to a channel the results of a job. This is how I most commonly see it at customers.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬

[jonahgreenthal]

This is still about a significant issue that has not been satisfactorily resolved.

[armyost]

I'm using Google Chat notification. I think there are other notification steps for various platform.

      # Workflow complete Notification
      - name: Google-Chat-Notification
        uses: Co-qn/google-chat-notification@releases/v1
        with:
          name: Result
          url: ${{ env.GOOGLE_CHAT_URL }}
          status: ${{ job.status }}
        if: ${{ always() }}

[PaulRBerg]

Any ETA for when this basic functionality will be supported?

[shayki5]

+1

It's super basic feature!

[aking-ed]

Yes, I am surprised this can't be done out of the box. we have a nightly job, and it is just random who gets notified about its failure (just whoever happened to merge in the most recent PR). not intuitive at all!

[piotrekkr]

I'm using GitHub Actions daily for more than four years and my experience is that they do not care about normal user feedback and needs. I can see some enterprise "features" added from time to time but nothing needed or useful to the community. So do not put much hope in them.

There are some common workarounds to the missing notifications feature like:

1. I you have multiple jobs in a workflow, add notification job as last job that needs other jobs and then run it on if: failure(). This will execute this job if any of needed jobs failed. There you can use curl, some script or action to send notification to selected people.
2. If you have only one job in workflow you can add a last step with notification logic that would run also on if: failure().
3. There are also webhook events and you could send event on workflow run to some external endpoint and handle notification there.

[rocarrillos]

+1 can't believe there isn't a simple way to do this

[PaulRBerg]

You can here see an example of how we implemented this using the rtCamp/action-slack-notify action:

  notify-on-failure:
    if: failure()
    needs: ["lint", "build", "test-unit", "test-integration", "test-invariant", "test-fork"]
    runs-on: "ubuntu-latest"
    steps:
      - name: "Send Slack notification"
        uses: "rtCamp/action-slack-notify@v2"
        env:
          SLACK_CHANNEL: "#ci-notifications"
          SLACK_MESSAGE: "CI Workflow failed for ${{ github.repository }} on branch ${{ github.ref }} at job ${{ github.job }}."
          SLACK_USERNAME: "GitHub CI"
          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}

[PsiKai]

I'm leaving an organization where I've configured many cron schedule workflows. Right now, I'm the maintainer as well, so it makes sense that I get the email on failure. When I leave, these workflows will just silently fail with no notification system.

Please Github, just a basic feature to configure a mailing list for actions failures!

[poslogica]

I require this in my workflows too.
Would be good that GH supports this natively!

[JonJagger]

+42

[zsiegel92]

+1

[Harrysharmax]

Use a Team Messaging Platform
How it works:

1. Generate a Webhook URL: In your Slack or Teams channel, create an "Incoming Webhook." This gives you a unique, secret URL.
2. Store the URL as a Secret: In your GitHub repository, go to Settings > Secrets and variables > Actions and add the webhook URL as a secret (e.g., SLACK_WEBHOOK_URL).
3. Add a Step to Your Workflow: Add a final step to your job that only runs on failure using the if: failure() condition.
   Here's an example for Slack:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Run build steps
        run: |
          # Your build and test commands go here
          # Let's assume this step fails
          exit 1

      - name: Notify team on failure
        if: failure()
        uses: slackapi/slack-github-action@v1.26.0
        with:
          channel-id: 'C12345678' # Or your channel name
          slack-message: "🚨 Workflow failed! Name: ${{ github.workflow }}, Job: ${{ github.job }}. See details: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
        env:
          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }} # Or use SLACK_WEBHOOK_URL with a different action/method

or you can Use a Dedicated Email Service 📧
If you prefer email, use a transactional email service like SendGrid or Mailgun instead of your personal account. These services use revocable API keys for authentication, which is much more secure than a password.

How it works:

1. Sign up for a service (most have a generous free tier).
2. Get an API key and add it to your GitHub secrets.
3. Use a GitHub Action like dawidd6/action-send-mail configured to use your service's API key.

[shayki5]

Use a Team Messaging Platform How it works:

1. Generate a Webhook URL: In your Slack or Teams channel, create an "Incoming Webhook." This gives you a unique, secret URL.
2. Store the URL as a Secret: In your GitHub repository, go to Settings > Secrets and variables > Actions and add the webhook URL as a secret (e.g., SLACK_WEBHOOK_URL).
3. Add a Step to Your Workflow: Add a final step to your job that only runs on failure using the if: failure() condition.
   Here's an example for Slack:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Run build steps
        run: |
          # Your build and test commands go here
          # Let's assume this step fails
          exit 1

      - name: Notify team on failure
        if: failure()
        uses: slackapi/slack-github-action@v1.26.0
        with:
          channel-id: 'C12345678' # Or your channel name
          slack-message: "🚨 Workflow failed! Name: ${{ github.workflow }}, Job: ${{ github.job }}. See details: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
        env:
          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }} # Or use SLACK_WEBHOOK_URL with a different action/method

or you can Use a Dedicated Email Service 📧 If you prefer email, use a transactional email service like SendGrid or Mailgun instead of your personal account. These services use revocable API keys for authentication, which is much more secure than a password.

How it works:

1. Sign up for a service (most have a generous free tier).
2. Get an API key and add it to your GitHub secrets.
3. Use a GitHub Action like dawidd6/action-send-mail configured to use your service's API key.

But it's Slack, not email... for Slack there is official GitHub App..

[iainross]

+one million

How is this not out of the box?

[APEX-SAID-SHAMKHALI]

+1 Please, this feature would be very useful, specially in enterprise scenarios.

[CodyCBakerPhD]

+1 Asking for this yet again! Would simplify many of our workflows

[lukegregorio]

+! again, this would be so useful for us

[beiglboe]

Come on, please @github

[Suhas-Chandrashekar]

Hello All, I also had similar requirements. However, I used Sendgrid and is working fine and meeting my Requirements. Sharing it here if it helps others too.

(You may ignore if it doesn't help in this context)

• You may add multiple email ID's as TO Recipients &
• You may add multiple email ID's as CC Recipients.
• Also, you may specify the Distribution List too.

   notify-on-failure:
      runs-on: ubuntu-latest
      needs: [<Add/Link_your_previous_jobs_name>, <Add/Link_your_previous_jobs_name>]
      if: always() && (<Add/Link_your_previous_jobs_names> == 'failure' || <Add/Link_your_previous_jobs_names> == 'failure')

      steps:
        - name: Send failure notification via SendGrid
          env:
            SENDGRID_API_KEY: ${{ secrets.SENDGRID_API_KEY }}
          run: |
            CURRENT_DATE=$(date '+%d-%m-%Y')
            
            curl -X POST https://api.sendgrid.com/v3/mail/send \
              -H "Authorization: Bearer ${SENDGRID_API_KEY}" \
              -H "Content-Type: application/json" \
              -d @- <<EOF
            {
              "personalizations": [
                {
                    "to": [
                      {"email": "email-1"},
                      {"email": "email-2"}
                    ],
                    "cc": [
                      {"email": "email-1"},
                      {"email": "email-2"}
                    ],
                  "subject": "<Subject_Goes_here>"
                }
              ],
              "from": {
                "email": "<FROM_Email_Address>",
                "name": "<FROM_Email_Name>"
              },
              "content": [
                {
                  "type": "text/plain",
                  "value": "<Content/Body_Goes_here>"
                }
              ]
            }
            EOF

Thanks & Regards,
Suhas Chandrashekar

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬