diff --git a/README.md b/README.md index bb0327f7..5fe4964c 100644 --- a/README.md +++ b/README.md @@ -581,7 +581,7 @@ endpoints: | `alerting.gitlab` | Configuration for alerts of type `gitlab`.
See [Configuring GitLab alerts](#configuring-gitlab-alerts). | `{}` | | `alerting.googlechat` | Configuration for alerts of type `googlechat`.
See [Configuring Google Chat alerts](#configuring-google-chat-alerts). | `{}` | | `alerting.gotify` | Configuration for alerts of type `gotify`.
See [Configuring Gotify alerts](#configuring-gotify-alerts). | `{}` | -| `alerting.incident-io` | Configuration for alerts of type `incident-io`.
See [Configuring Incident.io alerts](#configuring-incidentio-alerts). | `{}` | +| `alerting.incident-io` | Configuration for alerts of type `incident-io`.
See [Configuring Incident.io alerts](#configuring-incidentio-alerts). | `{}` | | `alerting.jetbrainsspace` | Configuration for alerts of type `jetbrainsspace`.
See [Configuring JetBrains Space alerts](#configuring-jetbrains-space-alerts). | `{}` | | `alerting.matrix` | Configuration for alerts of type `matrix`.
See [Configuring Matrix alerts](#configuring-matrix-alerts). | `{}` | | `alerting.mattermost` | Configuration for alerts of type `mattermost`.
See [Configuring Mattermost alerts](#configuring-mattermost-alerts). | `{}` | @@ -907,16 +907,17 @@ Here's an example of what the notifications look like: ![Gotify notifications](.github/assets/gotify-alerts.png) + #### Configuring Incident.io alerts -| Parameter | Description | Default | -|:-----------------------------------|:-------------------------------------------------------------------------------------------|:--------------| -| `alerting.incident-io` | Configuration for alerts of type `incident-io` | `{}` | -| `alerting.incident-io.url` | url to trigger an alert event. | Required `""` | -| `alerting.incident-io.auth-token` | Token that is used for authentication. | Required `""` | -| `alerting.incident-io.overrides` | List of overrides that may be prioritized over the default configuration | `[]` | +| Parameter | Description | Default | +|:-----------------------------------------|:-------------------------------------------------------------------------------------------|:--------------| +| `alerting.incident-io` | Configuration for alerts of type `incident-io` | `{}` | +| `alerting.incident-io.url` | url to trigger an alert event. | Required `""` | +| `alerting.incident-io.auth-token` | Token that is used for authentication. | Required `""` | | `alerting.incident-io.default-alert` | Default alert configuration.
See [Setting a default alert](#setting-a-default-alert) | N/A | +| `alerting.incident-io.overrides` | List of overrides that may be prioritized over the default configuration | `[]` | | `alerting.incident-io.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` | -| `alerting.incident-io.overrides[].*` | See `alerting.incident-io.*` parameters | `{}` | +| `alerting.incident-io.overrides[].*` | See `alerting.incident-io.*` parameters | `{}` | ```yaml alerting: @@ -937,13 +938,11 @@ endpoints: description: "healthcheck failed" send-on-resolved: true ``` -in order to get the required alert source config id and authentication token, you must configure an HTTP alert source. +In order to get the required alert source config id and authentication token, you must configure an HTTP alert source. > **_NOTE:_** the source config id is of the form `api.incident.io/v2/alert_events/http/$ID` and the token is expected to be passed as a bearer token like so: `Authorization: Bearer $TOKEN` -> **_NOTE:_** ``` - #### Configuring JetBrains Space alerts | Parameter | Description | Default | |:--------------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|