Skip to content

Commit c602121

Browse files
rhttimabbott
authored andcommitted
slack bridge: Update doc for current version of making Slack bot user.
1 parent 71d488e commit c602121

File tree

1 file changed

+13
-3
lines changed
  • zulip/integrations/bridge_with_slack

1 file changed

+13
-3
lines changed

zulip/integrations/bridge_with_slack/README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,19 @@ This is a bridge between Slack and Zulip.
1515
### 2. Slack endpoint
1616
1. Make sure Websocket isn't blocked in the computer where you run this bridge.
1717
Test it at https://www.websocket.org/echo.html.
18-
2. Go to https://api.slack.com/apps?new_classic_app=1 and create a new classic app (note: must be a classic app). Choose a bot name that will be put into bridge_with_slack_config.py, e.g. "zulip_mirror". Make sure to install the app to the workspace. When successful, you should see a token that starts with "xoxb-..." (there is also a token that starts with "xoxp-...", we need the "xoxb-..." one).
19-
3. (Important) Make sure the bot is subscribed to the channel. You can do this by typing e.g. `/invite @zulip_mirror` in the relevant channel.
20-
4. In the `slack` section of the configuration file, enter the bot name (e.g. "zulip_mirror") and token, and the channel ID (note: must be ID, not name).
18+
2. Go to https://api.slack.com/apps?new_classic_app=1 and create a new classic
19+
app (note: must be a classic app). Choose a bot name that will be put into
20+
bridge_with_slack_config.py, e.g. "zulip_mirror". In the process of doing
21+
this, you need to add oauth token scope. Simply choose `bot`. Slack will say
22+
that this is a legacy scope, but we still need to use it anyway. The reason
23+
why we need the legacy scope is because otherwise the RTM API wouldn't work.
24+
We might remove the RTM API usage in newer version of this bot. Make sure to
25+
install the app to the workspace. When successful, you should see a token
26+
that starts with "xoxb-...". There is also a token that starts with
27+
"xoxp-...", we need the "xoxb-..." one.
28+
3. Go to "App Home", click the button "Add Legacy Bot User".
29+
4. (Important) Make sure the bot is subscribed to the channel. You can do this by typing e.g. `/invite @zulip_mirror` in the relevant channel.
30+
5. In the `slack` section of the Zulip-Slack bridge configuration file, enter the bot name (e.g. "zulip_mirror") and token, and the channel ID (note: must be ID, not name).
2131

2232
### Running the bridge
2333

0 commit comments

Comments
 (0)