Skip to content

Commit

Permalink
update the Slack description [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
bahmutov committed Sep 28, 2022
1 parent 7dfa6d7 commit 4a5b165
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
![Notify Slack messages](./images/notify.png)

To use this plugin, you will need to get yourself a `SLACK_TOKEN` by making a new Slack App. This app needs a bot token with the scope `"chat:write"` to post messages. If you want to tag specific users, you will need to give the app `"users:read"` too. For details, see [Slack API docs](https://api.slack.com/methods/chat.postMessage). You will need to invite the registered and installed Slack App to each channel you would like to post messages by this plugin.
## Slack App

To use this plugin, you will need to get yourself a `SLACK_TOKEN` by making a new Slack App. This app needs a bot token with the scope ["chat:write"](https://api.slack.com/scopes/chat:write) to post messages using [`chat.postMessage`](https://api.slack.com/methods/chat.postMessage) method. If you want to tag specific users in the messages, you will need to give the app the permission scope ["users:read"](https://api.slack.com/scopes/users:read) too; it allows the plugin to call [`users.list`](https://api.slack.com/methods/users.list) method to include the user ID in the messages. You will need to invite the registered and installed Slack App to each channel you would like to post messages by this plugin.

## Install

Expand Down

0 comments on commit 4a5b165

Please sign in to comment.