Cannot Install Slack App using the Python Slack Adapter Documentation

[apburnie]

Hi. I am trying to set up a chatbot on Microsoft Azure that users can communicate with through Slack. As a first step, I am trying to get the Microsoft sample to work but am having the following difficulties with the documentation. I would greatly appreciate help on this issue. Thank you in advance.

##Sample Information

Sample Type: \samples
Sample Language: Python
Sample Name: 60.slack-adapter

Describe the bug

The README.md file is incomplete in the following regards:

• Step 2 of Section Gather required configuration settings for your bot refers to installing the Slack App, but Slack states that this cannot be done without 'one feature or permission scope' first being added. What are the features or permission scopes that should be added?

• Section Update your Slack app states 'You now need to configure 2 URLs for your app and subscribe to the appropriate events'. I understand one of the URLs is the Ngrok URL, but what is the second URL?

• Step 1 of Section Update your Slack app states "In the Event Subscriptions tab, fill in the 'Request URL' with the same URL you used in step 1". Given that this is step 1 of the section, what URL is this step referring to?

To Reproduce

Examine the README file at BotBuilder-Samples/samples/python/60.slack-adapter/README.md and attempt to replicate the stated steps.

[v-kydela]

Thank you for the report, @Andrew47

It looks like the instructions for using a Slack adapter are indeed incorrect and will need to be updated here, here, and here. In addition to the problems you stated, it looks like the instructions also say to subscribe to the event im_created which doesn't exist.

The docs page currently has four open issues, so hopefully the instructions will be redone to account for the way Slack currently works. In the meantime, you can get past your issues like this:

• Skip to "Update your Slack app" step 4 to see what bot token scopes to add in order to install your app and get a bot token
• I think it's just one URL, but in two places
• It's referring to the "/api/slack" URL

I will unassign myself so the appropriate people can have a look at this.

[jwiley84]

Hi @Andrew47 The Slack documentation has recently been updated. Can you attempt to reconnect slack using the updated instructions and let me know how it goes?

[apburnie]

Hi @jwiley84

Thank you for coming back on the above raised issues with the documentation - it is very much appreciated.

I think the problems described above are with the recently updated Slack documentation. I have had another look at the documentation and am still finding that the above issues exist. The README file was updated 9 months ago, whilst the above issues were detected 16 days ago. For convenience, the problems described above are with the documentation at https://github.com/microsoft/BotBuilder-Samples/tree/main/samples/python/60.slack-adapter.

Once again, thanks for your help on this issue. I am looking forward to its resolution.

[jwiley84]

Oh! I apologize. I just saw that I didn't link the documentation I was talking about: https://docs.microsoft.com/en-us/azure/bot-service/bot-service-channel-connect-slack?view=azure-bot-service-4.0&tabs=abs

I will double check the readme on this sample and get any incorrect portion fixed. Thank you for bringing this to our attention.

[tonyanziano]

@jwiley84 any updates on fixing the documentation?

[EricDahlvang]

The readme updates have been merged. Thanks @jwiley84

[v-kydela]

Was there a decision made to only update the instructions in one place instead of three? And was it determined that im_created is a Slack event after all?

[EricDahlvang]

@v-kydela Should more places be updated? I'm not sure about im_created, is it a Slack event after all?

[v-kydela]

@EricDahlvang - Are you able to see the comment I made on October 28 containing the research I did before unassigning myself?

[EricDahlvang]

Yes, i'm able to see the comment.

[v-kydela]

Reopening as not resolved. Please refer to this comment to see what needs to be fixed.

[EricDahlvang]

@v-kydela the referenced docs page no longer has four open issues. I do not have the context to know if that means the above has been fully resolved. Please describe which part of your comment above still needs to be addressed, and what you recommend?

[v-kydela]

@EricDahlvang - It all still needs to be addressed except for the part JJ fixed. It doesn't look like the open issues I mentioned were relevant here. I recommend transferring this to the docs team so they can come up with new instructions based on how Slack currently works.

JJ fixed the three specific things the customer mentioned in the one specific document the customer was looking at, but she missed the problem with obsolete Slack events. So to resolve this issue, we could fix the im_created problem in the Python readme and fix all four problems in the C# readme and the bot docs. I'm reluctant to leave it at that because there are more points of confusion in the Slack adapter instructions and I think it deserves a thorough read-over. I opened an issue in the .NET repo because the Slack adapter itself is confusing: microsoft/botbuilder-dotnet#5115

[srinaath]

Closing for inactivity.