GitHub Actions
Let automated workflows notify you.
Set BREEZE_SERVER to https://push.breezelabs.dev and store your key as the environment secret BREEZE_WEBHOOK_KEY.
Create an Actions secret named BREEZE_WEBHOOK_KEY in the target repository, containing only the send key. Run this workflow manually to verify delivery. The example does not automatically modify the repository or request additional repository permissions.
name: Send Breeze notification
on:
workflow_dispatch:
permissions: {}
jobs:
notify:
runs-on: ubuntu-24.04
timeout-minutes: 1
env:
BREEZE_SERVER: https://push.breezelabs.dev
BREEZE_WEBHOOK_KEY: ${{ secrets.BREEZE_WEBHOOK_KEY }}
steps:
- name: Send notification
shell: bash
run: |
test -n "$BREEZE_WEBHOOK_KEY"
curl --silent --show-error --fail-with-body \
--connect-timeout 5 --max-time 20 \
"$BREEZE_SERVER/v1/send" \
-H "Authorization: Bearer $BREEZE_WEBHOOK_KEY" \
-H 'Content-Type: application/json' \
--data-binary '{"title":"GitHub Actions","message":"The notification workflow has run","thread_id":"github-actions"}'
Production scripts should also parse the response and define handling for statuses such as 207 and 429. curl --fail-with-body primarily handles 4xx / 5xx responses; it does not treat 207 as a failure. Do not insert external text from issues, commit messages, or similar sources directly into shell commands or JSON; serialize it as JSON first. For secret configuration and scope, see the official GitHub documentation.