Skip to content

Commit 6906984

Browse files
committed
slack bridge: Update doc for the new webhook based Slack Bridge.
This commit updates the Slack Bridge doc, primarily guiding the user to use our Slack Webhook integration and reformating the old instructions to a separate legacy section.
1 parent 20ccb22 commit 6906984

File tree

1 file changed

+53
-1
lines changed
  • zulip/integrations/bridge_with_slack

1 file changed

+53
-1
lines changed

zulip/integrations/bridge_with_slack/README.md

+53-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,50 @@ This is a bridge between Slack and Zulip.
44

55
## Usage
66

7+
### 1. Zulip endpoint
8+
9+
1. Create a generic Zulip bot, with a full name like `Slack Bot`.
10+
11+
2. (Important) Subscribe the bot user to the Zulip stream you'd like to bridge your Slack
12+
channel into.
13+
14+
3. Create a [Slack Webhook integration bot][slack_webhook_doc] to get messages form Slack to Zulip.
15+
16+
4. In the `zulip` section of the configuration file, enter the **Generic bot's** `zuliprc`
17+
details (`email`, `api_key`, and `site`).
18+
19+
5. After that, fill `integration_bot_email` with **Integration bot**'s email. Note that this is
20+
the bot you created in step 3 and not in step 1.
21+
22+
6. In the same section, also enter the Zulip `stream` and `topic`.
23+
24+
7. (Important) In the `zulip` section of the configuration file, enter the
25+
26+
8. In the same section, also enter the Zulip `channel` and `topic`. Make sure
27+
these match the ones your bot is sending to.
28+
29+
### 2. Slack endpoint
30+
31+
1. Go to the [Slack Apps menu][slack_apps_menu] and open the same Slack app that you have use
32+
to set up the Slack Webhook integration in the previous section.
33+
34+
2. Navigate to the "OAuth & Permissions" menu and note the "Bot User OAuth Token".
35+
It starts with "xoxp-...".
36+
37+
3. Scroll down to the "Scopes" section in the same page and make sure:
38+
- "Bot Token Scopes" includes: `chat:write`
39+
- "User Tokens Scopes" includes: `chat:write`
40+
41+
4. In the `slack` section of the Zulip-Slack bridge configuration file, enter the bot name
42+
(e.g "zulip_mirror"), token (e.g xoxp-...), and the channel ID (note: must be ID, not name).
43+
44+
### Running the bridge
45+
46+
Run Slack Bridge: `python3 run-slack-bridge`
47+
48+
<details>
49+
<summary>Legacy: If you're still using classic Slack app, follow this instruction instead!</summary>
50+
751
### 1. Zulip endpoint
852
1. Create a generic Zulip bot, with a full name like `Slack Bot`.
953
2. (Important) Subscribe the bot user to the Zulip stream you'd like to bridge your Slack
@@ -31,4 +75,12 @@ This is a bridge between Slack and Zulip.
3175

3276
### Running the bridge
3377

34-
Run `python3 run-slack-bridge`
78+
Run Legacy Slack Bridge: `python3 run-slack-bridge --legacy`
79+
80+
</details>
81+
82+
[incoming_webhook_doc] = https://zulip.com/help/add-a-bot-or-integration#add-a-bot-or-integration
83+
84+
[slack_webhook_doc] = https://zulip.com/integrations/doc/slack
85+
86+
[slack_apps_menu] = https://api.slack.com/apps

0 commit comments

Comments
 (0)