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.

Sign up for GitHub

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

Jump to bottom

feat(docs-site) slack bot scopes #11727

Merged
merged 3 commits into from
Oct 28, 2024
Merged

feat(docs-site) slack bot scopes #11727

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26e5912
feat(docs-site) slack bot scopes
jayacryl Oct 28, 2024
179d152
Merge branch 'master' into jp--slack-bot-scopes
jayacryl Oct 28, 2024
a67c5cb
Merge branch 'master' into jp--slack-bot-scopes
jayacryl Oct 28, 2024
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
39 changes: 38 additions & 1 deletion docs/managed-datahub/slack/saas-slack-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import FeatureAvailability from '@site/src/components/FeatureAvailability';
<FeatureAvailability saasOnly />

## 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
<div align="center"><iframe width="560" height="315" src="https://www.loom.com/embed/af6fcfd435cf4993b79a0c8e13aecaaa?sid=93f2a66b-1362-4809-996b-5abb399f82dd" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe></div>
Expand Down Expand Up @@ -44,6 +44,43 @@ The following steps should be performed by a Slack Workspace Admin.

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
```


<!-- NOTE: we are hiding this method for now. If a need arises, we can uncomment below docs.
# Bot Token Method (Not recommended)

Expand Down