Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

integration docs: Simplify create a bot instructions.

This commit is contained in:
Rishi Gupta 2018-08-20 20:31:27 -07:00 committed by Tim Abbott
parent 62b93d551a
commit e9e2721aa2
4 changed files with 4 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
templates/zerver/help/include/create-a-bot-indented.md
View File

@ -1,12 +1,7 @@
On your {{ settings_html|safe }}, [Create a bot](/help/add-a-bot-or-integration) for
[create a bot](/help/add-a-bot-or-integration) for
{{ integration_display_name }}. Make sure that you select {{ integration_display_name }}. Make sure that you select
**Incoming webhook** as the **Bot type**: **Incoming webhook** as the **Bot type**:
![](/static/images/help/bot_types.png) ![](/static/images/help/bot_types.png)
The API key for an incoming webhook bot cannot be used to read messages out
of Zulip. Thus, using an incoming webhook bot lowers the security risk of
exposing the bot's API key to a third-party service.
Fill out the rest of the fields, and click **Create bot**. Fill out the rest of the fields, and click **Create bot**.

7
templates/zerver/help/include/create-a-bot.md
View File

@ -1,12 +1,7 @@
On your {{ settings_html|safe }}, [Create a bot](/help/add-a-bot-or-integration) for
[create a bot](/help/add-a-bot-or-integration) for
{{ integration_display_name }}. Make sure that you select {{ integration_display_name }}. Make sure that you select
**Incoming webhook** as the **Bot type**: **Incoming webhook** as the **Bot type**:
![](/static/images/help/bot_types.png) ![](/static/images/help/bot_types.png)
The API key for an incoming webhook bot cannot be used to read messages out
of Zulip. Thus, using an incoming webhook bot lowers the security risk of
exposing the bot's API key to a third-party service.
Fill out the rest of the fields, and click **Create bot**. Fill out the rest of the fields, and click **Create bot**.

5
templates/zerver/help/include/create-stream.md
View File

@ -1,5 +1,2 @@
Create the stream you'd like to use for Create the stream you'd like to use for
{{ integration_display_name }} notifications, and subscribe all {{ integration_display_name }} notifications.
interested parties to this stream. We recommend the
name `{{ recommended_stream_name }}`. You still need to create
the stream even if you are using this default recommendation.

2
templates/zerver/help/include/webhook-url.md
View File

@ -1 +1 @@
`{{ api_url }}{{ integration_url }}?api_key=abcdefgh&stream={{ recommended_stream_name }}` `{{ api_url }}{{ integration_url }}?api_key=abcdefgh&stream=stream_name`