paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

webhooks/beeminder/doc.md: Add instructions for creating a bot.

Browse Source
This commit is contained in:
Ricky
2018-02-04 12:37:42 +05:30
committed by Tim Abbott
parent 77760d9f6c
commit db152da7c9
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
zerver/webhooks/beeminder/doc.md
View File

@@ -2,6 +2,18 @@ Get Beeminder notifications in Zulip whenever you're going to derail from your g
{!create-stream.md!}
Next, on your {{ settings_html|safe }}, [create a bot](/help/add-a-bot-or-integration) for
{{ integration_display_name }}. Make sure that you select
**Incoming webhook** as the **Bot type**:
![](/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.
Construct the URL for the Beeminder bot using the bot's API key and your Zulip email.
The webhook URL should look like:
`{{api_url}}?api_key=BOT'S_API_KEY&email=foo@example.com`