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

integrations-docs: Update text in `create-bot-construct-url.md`. 

Revises the text about including a stream and a topic incoming
webhook URLs in `create-bot-construct-url.md` for clarity and
consistency.
This commit is contained in:
Lauryn Menard 2022-08-19 18:56:01 +02:00 committed by Tim Abbott
parent 038880338f
commit 704e39f1b4
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
templates/zerver/help/include/create-bot-construct-url.md
View File

@ -6,16 +6,20 @@ bot using the bot's API key and the desired stream name:
{!webhook-url.md!}
Modify the parameters of the URL above, where `api_key` is the API key
of your Zulip bot, and `stream` is the [URL-encoded](https://www.urlencoder.org/)
stream name you want the notifications sent to. If you do not specify a
`stream`, the bot will send notifications via PMs to the creator of the bot.
of your Zulip bot, and `stream` is the [URL-encoded][url-encoder]
stream name you want the notifications sent to. If you don't specify a
`stream`, the bot will send notifications via private messages to the
creator of the bot.
If you'd like this integration to always send to a specific topic,
just include the (URL-encoded) topic as an additional parameter
(E.g. for `your topic`, append `&topic=your%20topic` to the URL).
If you'd like this integration to always send notifications to a
specific topic in the specified stream, just include the
[URL-encoded][url-encoder] topic as an additional parameter. E.g.,
for `your topic`, append `&topic=your%20topic` to the URL.
{% if all_event_types is defined %}
{!event-filtering-instruction.md!}
{% endif %}
[url-encoder]: https://www.urlencoder.org/