Simple integration with the API Alerts platform to send a notification to your device during a GitHub action pipeline.

Required API Key of the workspace to notify.

Get your workspace API Key from the Workspaces page in the mobile app.

Required The notification message to be sent to your devices

Optional Workspace channel to send the event to. Defaults to the default channel if not supplied

Optional Comma separated list of tags to attach to the event.

Optional Link to attach to the event

Minimal usage

- name: API Alerts Notify
  uses: apialerts/notify-action@v1
  with:
    api_key: ${{ secrets.API_ALERTS_KEY }}
    message: 'Production website deployed'

Full usage

- name: API Alerts Notify
  uses: apialerts/notify-action@v1
  with:
    api_key: ${{ secrets.API_ALERTS_KEY }}
    channel: 'integration'
    message: 'Production website deployed'
    tags: 'Deploy,Production,Web,CI/CD'
    link: 'https://apialerts.com'

Tip: Create a new GitHub action secret in your repository with the name API_ALERTS_KEY to secure your workspace key.