Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

10823 update slack installation doc #10940

Merged
merged 5 commits into from
Feb 24, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog/10940.doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added an additional step to `Receiving Messages` section in slack.mdx documentation. After a slack update this
addiotional step is needed to allow direct messages to the bot.
Binary file added docs/docs/connectors/img/slack-app-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 11 additions & 2 deletions docs/docs/connectors/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import interactivityImg from './img/slack-interactivity.png';
import requestUrlImg from './img/slack-request-url.png';
import scopesImg from './img/slack-scopes.png';
import secretImg from './img/slack-secret.png';
import appHomeImg from './img/slack-create-app.png';

Connecting a bot to Slack requires you to configure it to send messages
(using API credentials) and to receive messages (using a webhook).
Expand Down Expand Up @@ -110,7 +111,15 @@ your bot and tell you about new messages. If you are running locally, you can
If you are running locally, make sure ngrok (or another tool to retrieve a public
url) is running as well.

2. Configure the webhook by heading to **Event Subscriptions** and
2. To send messages directly to your bot using the slack UI, head to **App Home**,
scroll to bottom and turn on checkbox for
`Allow users to send Slash commands and messages from the messages tab.`

You might have to quit the Slack app and re-open it before this takes affect

<Image img={appHomeImg} caption="Messages Tab" alt="Allow users to send Slash commands and messages from the messages tab" max-width="500px"/>

3. Configure the webhook by heading to **Event Subscriptions** and
turning **Enable Events** on.

As a request URL enter the public url of your bot and append `/webhooks/slack/webhook`, e.g.
Expand All @@ -121,7 +130,7 @@ your bot and tell you about new messages. If you are running locally, you can

<Image img={requestUrlImg} caption="Request URL" alt="Request URL Screenshot" max-width="500px"/>

3. As a last step, you'll need to **Subscribe to bot events** on the same page.
4. As a last step, you'll need to **Subscribe to bot events** on the same page.
You'll need to add the following events:
- `message.channels`,
- `message.groups`,
Expand Down