Skip to content

Commit

Permalink
Add missing docs for Discord notifier
Browse files Browse the repository at this point in the history
Signed-off-by: Julius Volz <julius.volz@gmail.com>
  • Loading branch information
juliusv authored and hoperays committed Apr 23, 2023
1 parent ec60346 commit 12abfaf
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,8 @@ telegram_configs:
[ - <telegram_config>, ... ]
webex_configs:
[ - <webex_config>, ... ]
discord_configs:
[ - <discord_config>, ... ]
```

## `<email_config>`
Expand Down Expand Up @@ -1151,3 +1153,24 @@ room_id: <string>
# The HTTP client's configuration. You must use this configuration to supply the bot token as part of the HTTP `Authorization` header.
[ http_config: <http_config> | default = global.http_config ]
```

## `<discord_config>`

Discord notifications are sent via the [Discord webhook API](https://discord.com/developers/docs/resources/webhook). See Discord's ["Intro to Webhooks" article](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to learn how to configure a webhook integration for a channel.

```yaml
# Whether to notify about resolved alerts.
[ send_resolved: <boolean> | default = true ]

# The Discord webhook URL.
webhook_url: <secret>

# Message title template.
[ title: <tmpl_string> | default = '{{ template "discord.default.title" . }}' ]

# Message body template.
[ message: <tmpl_string> | default = '{{ template "discord.default.message" . }}' ]

# The HTTP client's configuration.
[ http_config: <http_config> | default = global.http_config ]
```

0 comments on commit 12abfaf

Please sign in to comment.