GitHub Actions

Use this for most workflows. Named with: inputs, listed on the GitHub Marketplace, pinned to a known-good version of the API Alerts JavaScript SDK under the hood. Runs on the GitHub-provided Node 24 runner - no separate install step.

@v2 always points at the latest 2.x release. Exact tags like @v2.2.0 are also published per release if you need to pin.

Use this if you’d rather call the API Alerts CLI directly. Same syntax you use locally, no action indirection. Slightly slower cold start while npx fetches the package.

npx @apialerts/cli always resolves the latest release. Pin to an exact version with npx @apialerts/[email protected].

Single notification

Inline the key. One step, one line.

- uses: apialerts/notify-action@v2
  with:
    api_key: ${{ secrets.APIALERTS_API_KEY }}
    event: ci.deploy.success
    message: '🚀 Production deployed'

Success and failure

Two steps with if: success() and if: failure() so each outcome has its own clean configuration. GitHub Actions skips steps after a failure by default, so the if: guards are what make the failure branch fire.

Set APIALERTS_API_KEY once at the job (or workflow) level so neither step has to repeat the credential.

jobs:
  deploy:
    env:
      APIALERTS_API_KEY: ${{ secrets.APIALERTS_API_KEY }}
    steps:
      - run: ./deploy.sh

      - if: success()
        uses: apialerts/notify-action@v2
        with:
          event: ci.deploy.success
          channel: releases
          message: '🚀 Production deployed'
          tags: deploy,production
          link: 'https://app.example.com'

      - if: failure()
        uses: apialerts/notify-action@v2
        with:
          event: ci.deploy.failure
          channel: releases
          message: '❌ Production deploy failed'
          tags: deploy,production
          link: ${{ format('{0}/{1}/actions/runs/{2}', github.server_url, github.repository, github.run_id) }}

Promote env: to the workflow root (above jobs:) instead of a single job if multiple jobs in the same file also fire notifications.

With all options

Every input the action accepts.

- uses: apialerts/notify-action@v2
  with:
    api_key: ${{ secrets.APIALERTS_API_KEY }}
    event: user.signup
    message: 'New user signed up'
    channel: developers
    title: 'New Signup'
    tags: signup,organic
    link: 'https://dashboard.example.com/users/123'
    data: '{"plan": "pro", "region": "us-east-1"}'

Simple notification

- name: Notify
  run: npx @apialerts/cli send -e ci.deploy.success -m '🚀 Production deployed'

Success and failure

- if: success()
  run: npx @apialerts/cli send -e ci.deploy.success -m '🚀 Production deployed' -c releases

- if: failure()
  run: npx @apialerts/cli send -e ci.deploy.failure -m '❌ Production deploy failed' -c releases -l "${{ format('{0}/{1}/actions/runs/{2}', github.server_url, github.repository, github.run_id) }}"

With all options

- name: Notify
  run: |
    npx @apialerts/cli send \
      -e user.signup \
      -m 'New user signed up' \
      -c developers \
      -t 'New Signup' \
      -g signup,organic \
      -l https://dashboard.example.com/users/123 \
      -d '{"plan":"pro","region":"us-east-1"}'