mirror of
https://github.com/zulip/zulip.git
synced 2025-11-21 15:09:34 +00:00
integrations: Add incoming webhook macro to relevant docs.
Several integration docs instruct the user to create a bot, but don't specify that the type of bot should be "Incoming webhook". Renames create-a-bot.md -> create-an-incoming-webhook.md for clarity, and replaces all incomplete instructions with this macro. Renames bot_types.png -> bot_types_incoming_webhook.png and updates the image with a screenshot of the latest UI.
This commit is contained in:
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB |
BIN
static/images/integrations/bot_types_incoming_webhook.png
Normal file
BIN
static/images/integrations/bot_types_incoming_webhook.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
@@ -2,4 +2,4 @@
|
|||||||
{{ 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**:
|
||||||
|
|
||||||

|

|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{!create-a-bot.md!}
|
{!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
Construct the URL for the {{ integration_display_name }}
|
Construct the URL for the {{ integration_display_name }}
|
||||||
bot using the bot's API key and the desired stream name:
|
bot using the bot's API key and the desired stream name:
|
||||||
|
|||||||
@@ -2,11 +2,7 @@ Get Zulip notifications for your Asana projects via Zapier!
|
|||||||
|
|
||||||
1. {!create-stream.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
1. Next, on your {{ settings_html|safe }}, create a bot for Asana.
|
1. {!create-bot-construct-url.md!}
|
||||||
Construct the URL for the Asana bot using the bot API key and
|
|
||||||
stream name, like so:
|
|
||||||
|
|
||||||
`{{ api_url }}/v1/external/zapier?api_key=abcdefgh&stream=asana`
|
|
||||||
|
|
||||||
1. Start by setting up a [Zapier](https://zapier.com/) account.
|
1. Start by setting up a [Zapier](https://zapier.com/) account.
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
Get Zulip notifications for your Capistrano deploys!
|
Get Zulip notifications for your Capistrano deploys!
|
||||||
|
|
||||||
1. {!create-a-bot.md!}
|
1. {!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
1. {!download-python-bindings.md!}
|
1. {!download-python-bindings.md!}
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Get Codebase notifications in Zulip!
|
|||||||
updates. We recommend naming the streams `codebase` and `tickets`, respectively.
|
updates. We recommend naming the streams `codebase` and `tickets`, respectively.
|
||||||
After creating these streams, make sure to subscribe all interested parties.
|
After creating these streams, make sure to subscribe all interested parties.
|
||||||
|
|
||||||
1. {!create-a-bot.md!}
|
1. {!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
1. {!download-python-bindings.md!}
|
1. {!download-python-bindings.md!}
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,4 @@
|
|||||||
1. On your {{ settings_html|safe }},
|
1. {!create-an-incoming-webhook.md!}
|
||||||
[create a bot](/help/add-a-bot-or-integration) for
|
|
||||||
{{ integration_display_name }}. Make sure that you select
|
|
||||||
**Incoming webhook** as the **Bot type**:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
The API keys for "Incoming webhook" bots are limited to only
|
The API keys for "Incoming webhook" bots are limited to only
|
||||||
sending messages via webhooks. Thus, this bot type lessens
|
sending messages via webhooks. Thus, this bot type lessens
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
Get Zulip notifications for your Git repositories!
|
Get Zulip notifications for your Git repositories!
|
||||||
|
|
||||||
1. {!create-a-bot.md!}
|
1. {!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
1. {!download-python-bindings.md!}
|
1. {!download-python-bindings.md!}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
1. {!create-stream.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
1. {!create-a-bot.md!}
|
1. {!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
1. Install the "Zulip" plugin by going to
|
1. Install the "Zulip" plugin by going to
|
||||||
**Manage Jenkins > Manage Plugins > Available**,
|
**Manage Jenkins > Manage Plugins > Available**,
|
||||||
|
|||||||
@@ -2,8 +2,7 @@
|
|||||||
|
|
||||||
1. {!download-python-bindings.md!}
|
1. {!download-python-bindings.md!}
|
||||||
|
|
||||||
1. Next, on your {{ settings_html|safe }}, create a bot for
|
1. {!create-an-incoming-webhook.md!}
|
||||||
{{ integration_display_name }}.
|
|
||||||
|
|
||||||
1. Next, open `integrations/nagios/zuliprc.example` in your favorite
|
1. Next, open `integrations/nagios/zuliprc.example` in your favorite
|
||||||
editor, and change the following lines to specify the email address
|
editor, and change the following lines to specify the email address
|
||||||
|
|||||||
@@ -4,12 +4,7 @@ important topics in real time.
|
|||||||
|
|
||||||
1. {!create-stream.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
1. Next, on your {{ settings_html|safe }},
|
1. {!create-an-incoming-webhook.md!}
|
||||||
[create a bot](/help/add-a-bot-or-integration) for
|
|
||||||
{{ integration_display_name }}. Make sure that you select
|
|
||||||
**Incoming webhook** as the **Bot type**:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
The API keys for "Incoming webhook" bots are limited to only
|
The API keys for "Incoming webhook" bots are limited to only
|
||||||
sending messages via webhooks. Thus, this bot type lessens
|
sending messages via webhooks. Thus, this bot type lessens
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ Zulip supports both SVN and Git notifications from Beanstalk.
|
|||||||
|
|
||||||
1. {!create-stream.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
1. {!create-a-bot.md!}
|
1. {!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
{!webhook-url-with-bot-email.md!}
|
{!webhook-url-with-bot-email.md!}
|
||||||
{!git-append-branches.md!}
|
{!git-append-branches.md!}
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ Get Zulip notifications for your Buildbot builds!
|
|||||||
|
|
||||||
1. {!create-stream.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
1. {!create-a-bot.md!}
|
1. {!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
1. Edit the Buildbot configuration file to add a new Zulip reporter
|
1. Edit the Buildbot configuration file to add a new Zulip reporter
|
||||||
([or follow the steps listed here][1]):
|
([or follow the steps listed here][1]):
|
||||||
|
|||||||
@@ -3,8 +3,7 @@
|
|||||||
Keep in mind you still need to create the stream first even
|
Keep in mind you still need to create the stream first even
|
||||||
if you are using this recommendation.
|
if you are using this recommendation.
|
||||||
|
|
||||||
1. Next, on your {{ settings_html|safe }}, create a bot and
|
1. {!create-an-incoming-webhook.md!}
|
||||||
note its email and API key.
|
|
||||||
|
|
||||||
1. Next, in Desk.com, open your **Admin** view via the top-left
|
1. Next, in Desk.com, open your **Admin** view via the top-left
|
||||||
dropdown. In the **Admin** view, click on **Apps**, then
|
dropdown. In the **Admin** view, click on **Apps**, then
|
||||||
|
|||||||
@@ -1,17 +1,16 @@
|
|||||||
Get personal message notifications in Zulip for the results of your Dialogflow queries!
|
Get personal message notifications in Zulip for the results of your
|
||||||
|
Dialogflow queries!
|
||||||
|
|
||||||
1. {!create-stream.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
1. Next, on your {{ settings_html|safe }}, [create a bot](/help/add-a-bot-or-integration) for
|
1. {!create-an-incoming-webhook.md!}
|
||||||
{{ integration_display_name }}. Make sure that you select
|
|
||||||
**Incoming webhook** as the **Bot type**.
|
|
||||||
|
|
||||||
The API key for an incoming webhook bot cannot be used to read messages out
|
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
|
of Zulip. Thus, using an incoming webhook bot lowers the security risk of
|
||||||
exposing the bot's API key to a third-party service.
|
exposing the bot's API key to a third-party service.
|
||||||
|
|
||||||
Construct the URL for the Dialogflow bot using the bot's API key and your Zulip email.
|
Construct the URL for the Dialogflow bot using the bot's API key and your
|
||||||
The webhook URL should look like:
|
Zulip email. The webhook URL should look like:
|
||||||
|
|
||||||
`{{api_url}}?api_key=BOT'S_API_KEY&email=foo@example.com`
|
`{{api_url}}?api_key=BOT'S_API_KEY&email=foo@example.com`
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
1. {!create-stream.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
1. Next, on your {{ settings_html|safe }}, create a bot and
|
1. {!create-an-incoming-webhook.md!}
|
||||||
note its email and API key.
|
|
||||||
|
|
||||||
1. In Home Assistant, you need to add the `notify` service to your
|
1. In Home Assistant, you need to add the `notify` service to your
|
||||||
`configuration.yaml` file. This should look something like this:
|
`configuration.yaml` file. This should look something like this:
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ sent by Zapier directly in Zulip.
|
|||||||
|
|
||||||
1. {!create-stream.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
1. {!create-a-bot.md!}
|
1. {!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
1. Create an account on [Zapier](https://zapier.com).
|
1. Create an account on [Zapier](https://zapier.com).
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
1. {!create-stream.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
1. Next, on your {{ settings_html|safe }}, create a bot.
|
1. {!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
1. Construct a webhook URL like the following:
|
1. Construct a webhook URL like the following:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user