feat(docs) steps on how to troubleshoot the slack command not working (…

…#11723) Co-authored-by: Maggie Hays <[email protected]>
datahub-project · Oct 28, 2024 · 838dfa4 · 838dfa4
1 parent 1cd4e57
commit 838dfa4
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/docs/managed-datahub/slack/saas-slack-troubleshoot.md b/docs/managed-datahub/slack/saas-slack-troubleshoot.md
@@ -69,3 +69,24 @@ If you've subscribed to an entity, and then performed an action (i.e., raised an
 ### There is an issue with DataHub's systems
 If sending a test notification works, and you've verified that none of the above cases apply, then you should contact your DataHub Customer Success rep to help troubleshoot and resolve the issue. 
 
+## Slack bot issues
+Below you'll find some tips to troubleshoot issues with your Slack bot.
+
+### Command failed with error "dispatch_failed"
+If you've installed the Slack bot, but your commands are failing with an error 'dispatch_failed', you can try the following to correct it.
+1. Open your DataHub cloud instance with the following url: `<your-instance-base-url>/settings/integrations/slack?display_all_configs=true`.
+2. Switch to the **Bot Token** tab.
+<p align="center">
+  <img width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/verify_tokens_1.png"/>
+</p>
+3. The values will be `**`'d out, but if any of these fields are empty (ie. Signing Secret), then you'll want to fill them in.
+4. Visit [api.slack.com/apps](https://api.slack.com/apps), and open your currently installed app. You will see fields like `App ID` and `Signing Secret` here:
+<p align="center">
+  <img width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/verify_tokens_2.png"/>
+</p>
+5. You can get your `Bot Token` from the **OAuth & Permissions** tab in the side nav.
+<p align="center">
+  <img width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/verify_tokens_3.png"/>
+</p>
+6. Paste the values in and hit **Update Configuration**.
+7. Test the Slack command now and it should work. If it still fails, please reach out to your DataHub Cloud admin to troubleshoot further.