From db152da7c93f5689df70e71278589706e723591a Mon Sep 17 00:00:00 2001 From: Ricky Date: Sun, 4 Feb 2018 12:37:42 +0530 Subject: [PATCH] webhooks/beeminder/doc.md: Add instructions for creating a bot. --- zerver/webhooks/beeminder/doc.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/zerver/webhooks/beeminder/doc.md b/zerver/webhooks/beeminder/doc.md index 07e2f845df..957744907e 100644 --- a/zerver/webhooks/beeminder/doc.md +++ b/zerver/webhooks/beeminder/doc.md @@ -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`