Integrate brrr with GitHub Actions

GitHub Actions can call your brrr webhook directly from a workflow step with curl. That makes it easy to send yourself a push when a workflow runs, finishes, or hits a condition you care about.

Store the webhook URL in your repository secrets as BRRR_WEBHOOK_URL. That keeps the secret out of your workflow file and makes it easy to rotate later.

Send a plain text body

This is a minimal workflow example:

name: Example Workflow
on:
  workflow_dispatch: {}
jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - name: Send notification with brrr
        run: |
          curl -X POST "${{ secrets.BRRR_WEBHOOK_URL }}" \
            -d "Hello world! 🚀"

This is a good fit when you only need a quick status update and do not need a title or any extra payload fields.

Send a JSON payload

Use JSON when you want a title or other supported payload fields:

name: Example Workflow
on:
  workflow_dispatch: {}
jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - name: Send notification with brrr
        run: |
          curl -X POST "${{ secrets.BRRR_WEBHOOK_URL }}" \
            -H "Content-Type: application/json" \
            -d '{"title":"Test from GitHub Actions","message":"Hello world! 🚀"}'

This gives you a more expressive notification and matches the JSON examples used elsewhere in the docs.

Learn more

Continue to Docs for the full payload format, including optional fields you can include in the JSON body.