Trigv GitHub Action

Official GitHub Action for Trigv — send a native push notification from your workflows with one step.

Trigv delivers alerts to your phone; notification title and body stay on your device. This action calls POST https://api.trigv.com/api/v1/events.

Quick start

1. Create an API key at app.trigv.com and subscribe your phone to a channel (default: general). See API keys.
2. Add a repository secret: TRIGV_API_KEY.
3. Add a step to your workflow:

- name: Notify Trigv on failure
  if: failure()
  uses: Trigv/trigv-github-action@v1.1.0
  with:
    api-key: ${{ secrets.TRIGV_API_KEY }}
    title: Workflow failed
    level: error
    event-type: ci.failed

Omit channel to use general, or set a slug (e.g. github) for a dedicated channel.

Notify on success

- name: Notify Trigv on success
  if: success()
  uses: Trigv/trigv-github-action@v1.1.0
  with:
    api-key: ${{ secrets.TRIGV_API_KEY }}
    title: Deploy OK
    level: success
    event-type: ci.success

When description is omitted, the action fills in repository, workflow, ref, and commit. The workflow run URL is sent in the dedicated url field (see below).

Pin the action to an exact release tag (e.g. @v1.1.0) so workflow behavior stays predictable.

Custom destination URL

By default, the action sends the current GitHub Actions run URL as url so the mobile app can open the workflow from the notification. Override it when you want a different link:

- name: Notify Trigv with deployment link
  uses: Trigv/trigv-github-action@v1.1.0
  with:
    api-key: ${{ secrets.TRIGV_API_KEY }}
    title: Production deploy complete
    level: success
    url: https://example.com/deployments/42

Inputs

Input	Required	Default	Description
api-key	yes	—	Trigv workspace API key (trgv_…)
channel	no	general	Channel slug
title	yes	—	Notification title
description	no	GitHub context	Notification body
level	no	info	info, success, warning, or error
event-type	no	—	Optional metadata (e.g. ci.failed)
delivery-urgency	no	standard	standard or time_sensitive
image-url	no	—	Optional HTTPS image URL
url	no	workflow run URL	Destination URL for the notification; defaults to the current GitHub Actions run URL when omitted
idempotency-key	no	—	Avoid duplicate events on retries
fail-on-error	no	false	Fail the step when the API errors

Outputs

Output	Description
ok	true when Trigv returns HTTP 200 or 202
status	HTTP status code
event-public-id	Trigv event public_id when present
response	JSON string of the API response

Docs

• GitHub Actions guide
• API errors & rate limits
• OpenAPI spec

License

MIT — see LICENSE.