From 1cd4e575520262856a82c5124a90eb05e87424cb Mon Sep 17 00:00:00 2001
From: Jay <159848059+jayacryl@users.noreply.github.com>
Date: Mon, 28 Oct 2024 19:06:21 -0400
Subject: [PATCH] feat(docs-site) slack bot scopes (#11727)
---
.../managed-datahub/slack/saas-slack-setup.md | 38 ++++++++++++++++++-
1 file changed, 37 insertions(+), 1 deletion(-)
diff --git a/docs/managed-datahub/slack/saas-slack-setup.md b/docs/managed-datahub/slack/saas-slack-setup.md
index f242d40203d081..9cc2ed6b966585 100644
--- a/docs/managed-datahub/slack/saas-slack-setup.md
+++ b/docs/managed-datahub/slack/saas-slack-setup.md
@@ -5,7 +5,7 @@ import FeatureAvailability from '@site/src/components/FeatureAvailability';
## Install the DataHub Slack App into your Slack workspace
-
+You can see the permissions required by the DataHub Slack bot [below](#datahub-slack-bot-permissions).
### Video Walkthrough
@@ -48,6 +48,42 @@ You may need approval from a workspace admin to do this step. Learn about [what
Now proceed to the [Subscriptions and Notifications page](https://datahubproject.io/docs/managed-datahub/subscription-and-notification) to see how you can subscribe to be notified about events on the platform, or visit the [Slack App page](saas-slack-app.md) to see how you can use DataHub's powerful capabilities directly within Slack.
+### DataHub Slack bot permissions
+The DataHub Slack bot requires a certain set of scopes (permissions) to function. We've listed them below with thier explanations.
+```
+# Required for slash commands / shortcuts.
+commands
+# Required to get @DataHub messages and send messages as @DataHub.
+app_mentions:read
+chat:write
+chat:write.public
+# When sending messages we want to use a custom icon_url so that we can display the DataHub Cloud logo.
+chat:write.customize
+# Required to see conversation details + read messages.
+channels:history
+channels:read
+groups:history
+groups:read
+im:history
+im:read
+mpim:history
+mpim:read
+metadata.message:read
+# Required to get workspace ID and create links to user profiles.
+team:read
+# Allows the bot to join a public channel when someone configures notifications to be sent to one.
+channels:join
+# Required to unfurl links.
+links:read
+links:write
+# Required to resolve user IDs to names/emails + enable lookup by email address.
+users:read
+users:read.email
+# Future-proofing.
+reactions:read
+reactions:write
+```
+
### Workspace admin approval guide
In some workspaces, you will find at step 6 above you will need approval from your workspace admin. In this case, you will want to:
1. On step #6 above, continue by clicking the button to request their approval.