Skip to main content
Version: Next

Configure Slack For Notifications

Feature Availability
Self-Hosted DataHub
DataHub Cloud

Install the DataHub Slack App into your Slack workspace​

Video Walkthrough​

Step-by-step guide​

The following steps should be performed by a Slack Workspace Admin.

  1. Navigate to https://api.slack.com/reference/manifests#config-tokens
  2. Under Managing configuration tokens, select 'Generate Token'

  3. Select your workspace, then hit 'Generate'

  4. Now you will see two tokens available for you to copy, an Access Token and a Refresh Token

  5. Navigate back to your DataHub Slack Integration setup page, and paste the tokens into their respective boxes, and click 'Connect'.

  6. You will be automatically re-directed to Slack to confirm DataHub Slack App's permissions and complete the installation process.
note

You may need approval from a workspace admin to do this step. Learn about what to do in this scenario here.

7. Congrats 🎉 Slack is set up! Now try it out by going to the **Platform Notifications** page

8. Enter your channel in, and click **'Send a test notification'**

Now proceed to the Subscriptions and Notifications page to see how you can subscribe to be notified about events on the platform, or visit the Slack App page to see how you can use DataHub's powerful capabilities directly within Slack.

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.
  2. Once approved, you will get a notification from the Slack bot that your request has been approved. Follow the link it provides to complete the process. If you do not get the message: visit api.slack.com/apps, open your DataHub app and complete the installation from there.
  3. Once it is done, you can visit <your-datahub-instance-url>/settings/notifications, and send a test notification to verify everything's working.
  4. Making Slack commands work: when running Slack commands such as /datahub search my dataset you may get a dispatch_failed error. To resolve this, see the steps here.

Sending Notifications​

For now, we support sending notifications to

  • Slack Channel Name (e.g. #troubleshoot)
  • Slack Channel ID (e.g. C029A3M079U)
  • Specific Users (aka Direct Messages or DMs) via user ID

By default, the Slack app will be able to send notifications to public channels. If you want to send notifications to private channels or DMs, you will need to invite the Slack app to those channels.

How to find Team ID and Channel ID in Slack​

note

We recommend just using the Slack channel name for simplicity (e.g. #troubleshoot).

Via Slack App:

  1. Go to the Slack channel for which you want to get a channel ID
  2. Click the channel name at the top

  3. At the bottom of the modal that pops up, you will see the Channel ID as well as a button to copy it

Via Web:

  1. Go to the Slack channel for which you want to get a channel ID

  2. Check the URL e.g. for the troubleshoot channel in OSS DataHub Slack

  3. Notice TUMKD5EGJ/C029A3M079U in the URL

  • Team ID = TUMKD5EGJ from above
  • Channel ID = C029A3M079U from above

How to find User ID in Slack​

Your User ID

  1. Click your profile picture, then select 'Profile'

  2. Now hit the '...' and select 'Copy member ID'

Someone else's User ID

  1. Click their profile picture in the Slack message

  2. Now hit the '...' and select 'Copy member ID'