paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-27 18:13:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update guidelines to URL-encode stream name or topic name.

Browse Source 
Updated create-bot-construct-url-indented.md file with
guidelines on how to URL-encode stream name and topic
name. The hyperlink added will solve the issue for those
who use emoji in stream name or topic name.

Tweaked by tabbott to edit the copy and update the non-indented
version as well.

Fixes #16430.
This commit is contained in:
akshatdalton
2020-10-20 23:05:09 +00:00
committed by Tim Abbott
parent ee1b2559f5
commit 1abae8baaa
2 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -6,9 +6,10 @@
{!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 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](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.
If you'd like this integration to always send to the topic
`your topic`, just add `&topic=your%20topic` to the end of the URL.
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).

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

@@ -6,9 +6,10 @@ 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 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](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.
If you'd like this integration to always send to the topic
`your topic`, just add `&topic=your%20topic` to the end of the URL.
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).