api-docs: Update outgoing webhooks page. #37016
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zulipbot
added
size: XL
area: documentation (api)
alya
added
the
integration review
Contributor
|
@timabbott Can you review this directly? It's not super easy for me to wrap my head around. |
timabbott
reviewed
Dec 12, 2025
api_docs/outgoing-webhooks.md
Outdated
| * Your new bot user will appear in the *Active bots* panel, which you | ||
| can use to edit the bot's settings. | ||
| which are notified when certain types of messages are sent in Zulip | ||
| When one of those events is [triggered](#triggering), we'll send an |
Member
There was a problem hiding this comment.
Nit: s/we'll/the zulip Server will/ -- generally "we" or "us" isn't language we use in docs to specify what the software will do.
Adds an instruction block for creating an outgoing webhook bot user. Makes some general revisions to the order of the content on the page, and adds some header links to help with navigating the content. Fixes zulip#36601.
In preparation for moving the majority of the outgoing webhook documentation to the help center, we move the payload content, which is partially generated from zerver/openapi/zulip.yaml, to a separate article in the API documentation.
timabbott
force-pushed
the
api-docs-update-outgoing-webhooks-page
branch
from
08fdde4 to
82f2613
Compare
Member
|
I made the small tweak noted above and merged, thanks @laurynmm! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #36601, with an additional prep commit for moving the outgoing webhook documentation from the API documentation to the help center (see #integrations > integration docs reorg).
Screenshots and screen captures:
CURRENT DOC
New page for outgoing webhook payload information, note that this content is just basically moved from the current doc linked above.
Not included in the screenshots is the majority of the Zulip format API as that content is generated from the zulip.yaml file, which is not edited as part of these changes.
Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: