Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zhammer committed Feb 25, 2024
1 parent 57253e8 commit 7123b2a
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions plugins/awards-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <my_slack_webhook_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
Expand Down

0 comments on commit 7123b2a

Please sign in to comment.