Skip to main content

GitHub alerts

Use GitHub when you want kwatch incidents delivered to this channel. This page is generated from the current provider catalog and lists every field accepted by the installed release.

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
tokenstringyesyesPersonal access token
ownerstringyesnoRepository owner
repostringyesnoRepository name
urlstringnonourlOptional endpoint override (e.g. GitHub Enterprise)
routesjsonnonojsonOptional JSON route filters.
retry.maxAttemptsintegernonointegerOptional maximum retry attempts.
retry.delaystringnonoOptional retry delay, for example 5s.
fallbackstringnonoOptional fallback provider name.

Minimal example

alert:
github:
token: "${file:/config/github-token}"

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.