diff --git a/plugins/awards-backend/README.md b/plugins/awards-backend/README.md index 76402dd..736e2f6 100644 --- a/plugins/awards-backend/README.md +++ b/plugins/awards-backend/README.md @@ -58,6 +58,23 @@ function makeCreateEnv(config: Config) { } ``` +## Configuration + +### Slack notifications + +To enable Slack notifications, add the following to your `app-config.yaml` file: + +```yaml +awards: + notifications: + slack: + webhook: + # https://api.slack.com/messaging/webhooks + url: +``` + +Users who have the `slack.com/user_id` annotation set (see [slack-catalog-backend](/plugins/slack-catalog-backend/README.md)) will be tagged in notifications that pertain to them. + ## Developing this plugin The plugin can be executed in isolation during development by running