Skip to main content

GitHub alerts

Send kwatch incident alerts to GitHub. Use the interactive manager for installation and credential setup. This page explains the provider fields and shows a minimal configuration fragment.

Before you start, have these values ready:

  • token — Personal access token.
  • owner — Repository owner.
  • repo — Repository name.

Credentials, tokens, keys, passwords, and webhook URLs must be mounted from a Kubernetes Secret. Use an exact ${file:/absolute/path} reference for every field marked Secret.

Configuration​

FieldTypeRequiredSecretValidationDefaultDescription
tokenstringyesyes——Personal access token
ownerstringyesno——Repository owner
repostringyesno——Repository name
urlstringnonourl—Optional endpoint override (e.g. GitHub Enterprise)
routesjsonnonojson—Optional JSON route filters.
retry.maxAttemptsintegernonointeger—Optional maximum retry attempts.
retry.delaystringnono——Optional retry delay, for example 5s.
fallbackstringnono——Optional fallback provider name.

Minimal example​

alert:
github:
token: "${file:/config/github-token}"
owner: <owner>
repo: <repo>

Add routes, retry, and fallback when you need delivery filtering or recovery. See the channels overview for guidance, or the complete provider reference for the catalog-wide view.