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

api-docs: Add tip for finding a stream or user ID. 

Adds a tip to the section on webhook URLs in the incoming webhook
overview and to the section on stream and user IDs in the construct
a narrow documentation. The tip links to relevant articles in the
help center.

Part of work on #19067.
This commit is contained in:
Lauryn Menard 2023-11-28 18:12:31 +01:00 committed by Tim Abbott
parent 276ceb46e2
commit 2f91179c1e
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api_docs/construct-narrow.md
View File

@ -105,6 +105,12 @@ help center because they are primarily useful to API clients:
* `dm-including:1234`: Search all direct messages (1-on-1 and group) * `dm-including:1234`: Search all direct messages (1-on-1 and group)
that include you and user ID `1234`. that include you and user ID `1234`.
!!! tip ""
A user ID can be found by [viewing a user's profile][view-profile]
in the web or desktop apps. A stream ID can be found when [browsing
streams][browse-streams] in the web app via the URL.
The operands for these search options must be encoded either as an The operands for these search options must be encoded either as an
integer ID or a JSON list of integer IDs. For example, to query integer ID or a JSON list of integer IDs. For example, to query
messages sent by a user 1234 to a direct message thread with yourself, messages sent by a user 1234 to a direct message thread with yourself,
@ -122,3 +128,6 @@ user 1234, and user 5678, the correct JSON-encoded query is:
} }
] ]
``` ```
[view-profile]: /help/view-someones-profile
[browse-streams]: /help/browse-and-subscribe-to-streams

6
api_docs/incoming-webhooks-overview.md
View File

@ -179,6 +179,11 @@ Parameters accepted in the URL include:
name. By default the integration will send direct messages to the name. By default the integration will send direct messages to the
bot's owner. bot's owner.
!!! tip ""
A stream ID can be found when [browsing streams][browse-streams]
in the web app via the URL.
* `topic`: The topic in the specified stream for the integration to * `topic`: The topic in the specified stream for the integration to
send notifications to. The topic should also be send notifications to. The topic should also be
[URL-encoded][url-encoder]. By default the integration will have a [URL-encoded][url-encoder]. By default the integration will have a
@ -189,5 +194,6 @@ Parameters accepted in the URL include:
notification. For details, see the integration's [integration notification. For details, see the integration's [integration
documentation](/integrations) page. documentation](/integrations) page.
[browse-streams]: /help/browse-and-subscribe-to-streams
[add-bot]: /help/add-a-bot-or-integration [add-bot]: /help/add-a-bot-or-integration
[url-encoder]: https://www.urlencoder.org/ [url-encoder]: https://www.urlencoder.org/