From 2f91179c1e2f66a0bb9f90b4b894182ee8067738 Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Tue, 28 Nov 2023 18:12:31 +0100 Subject: [PATCH] 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. --- api_docs/construct-narrow.md | 9 +++++++++ api_docs/incoming-webhooks-overview.md | 6 ++++++ 2 files changed, 15 insertions(+) diff --git a/api_docs/construct-narrow.md b/api_docs/construct-narrow.md index 8e322e8c07..a7e3554567 100644 --- a/api_docs/construct-narrow.md +++ b/api_docs/construct-narrow.md @@ -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) 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 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, @@ -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 diff --git a/api_docs/incoming-webhooks-overview.md b/api_docs/incoming-webhooks-overview.md index 361715c225..78393bbed2 100644 --- a/api_docs/incoming-webhooks-overview.md +++ b/api_docs/incoming-webhooks-overview.md @@ -179,6 +179,11 @@ Parameters accepted in the URL include: name. By default the integration will send direct messages to the 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 send notifications to. The topic should also be [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 documentation](/integrations) page. +[browse-streams]: /help/browse-and-subscribe-to-streams [add-bot]: /help/add-a-bot-or-integration [url-encoder]: https://www.urlencoder.org/