GitHub Actions Notifications

Get a push notification the moment your workflow finishes, with a direct link to the build, deployment, or failed run.

One step to add to any workflow

Add the API Alerts action to the end of any GitHub Actions workflow. It works with deployments, test suites, releases, scheduled jobs, and anything else you run in CI.

Use if: success() || failure() to send a notification no matter the outcome. The link field is the key part. On success it takes you straight to your build artifact. On failure it takes you to the Actions run so you can see what went wrong.

- name: Notify
  if: success() || failure()
  uses: apialerts/notify-action@v2
  with:
    api_key: ${{ secrets.API_ALERTS_KEY }}
    channel: 'developer'
    message: ${{ job.status == 'success' && '🚀 Deployed to staging' || '❌ Staging build failed' }}
    tags: 'deploy,staging'
    link: ${{ job.status == 'success' && 'https://appdistribution.firebase.google.com/testerapps/YOUR_APP_ID' || format('{0}/{1}/actions/runs/{2}', github.server_url, github.repository, github.run_id) }}

Why not just use GitHub’s notifications?

GitHub’s mobile app can notify you when a workflow finishes, but it stops there. You still have to navigate to the run, find the artifact, and figure out what to do next. With API Alerts:

  • Instant delivery - push notification arrives the moment the workflow completes
  • Direct links - tap the notification to open the build artifact, TestFlight, Firebase App Distribution, or the failed run
  • Custom messages - include the branch name, commit SHA, or any context you need
  • Channel routing - staging builds go to your developer channel, production releases go to the team

Built for mobile developers

Mobile CI builds can easily take 15-30 minutes. Instead of refreshing the Actions tab, context switch and get notified when the build is ready. Tap the notification and go straight to Firebase App Distribution or TestFlight to start testing.

Read our guide on mobile CI/CD build alerts for a full walkthrough with real Android and iOS workflows.

Works with any CI event

  • Deployments - know the moment your code hits production
  • Test suites - get alerted on failures without checking the PR
  • Scheduled workflows - confirm cron-style jobs ran successfully
  • Releases - notify your team when a new version is published
  • Security scans - immediate alerts on vulnerability findings

Get started

  1. Create a workspace and API key in the API Alerts dashboard
  2. Add API_ALERTS_KEY to your repository secrets
  3. Add the apialerts/notify-action@v2 step to your workflow

For the full input reference and more examples, see the GitHub Actions documentation.

View the action on the GitHub Marketplace.