Skip to content

fix: correct/improve webhook listener event descriptions and examples #13853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: correct/improve webhook listener event descriptions and examples #13853

wants to merge 1 commit into from
+301 −577

Conversation

@joshtrichards
Copy link
Member

@joshtrichards joshtrichards commented Nov 11, 2025

☑️ Resolves

Summary

  • Clarified missing id fields:
    • Added notes on when the id is missing from node event payloads, and recommended using the corresponding Before* event if the id is required.
  • Clearer event grouping and applies-to lists:
    • Grouped Node and Calendar Object events by payload format and specified which events use each type.
  • Added extensibility notice:
    • Clarified that installed apps can register additional webhook-compatible events, so available events may vary.
  • Context for optional app events:
    • Noted that Forms and Tables events apply only if those apps are installed.
  • Miscellaneous, Formatting and Sphinx improvements:
    • Made the JSON output prettier
    • Dropped duplicate paragraph
    • Improved blank line usage and literal formatting for better documentation rendering and consistency.

🖼️ Screenshots

image

@joshtrichards
fix: correct webhook listener event descriptions and examples
aed1fa4 
Updated the webhook listeners documentation for clarity and consistency, including corrections to event descriptions and examples.

Fixes:

- nextcloud/server#56371
- nextcloud/server#53648 (review)

Signed-off-by: Josh <[email protected]>
@joshtrichards joshtrichards added this to the Nextcloud 33 milestone Nov 11, 2025
This was referenced Nov 11, 2025
Merged
Open
marcelklehr
marcelklehr reviewed Nov 12, 2025
View reviewed changes
admin_manual/webhook_listeners/index.rst
"id": 437,
"path": "/admin/files/test-webhook.txt"
}
}
Copy link
Member

@marcelklehr marcelklehr Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't these have time and user variables as well?

@marcelklehr
Copy link
Member

marcelklehr commented Nov 12, 2025

Looks really good! Thank you @joshtrichards 💙 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@marcelklehr marcelklehr marcelklehr left review comments

@julien-nc julien-nc Awaiting requested review from julien-nc

@come-nc come-nc Awaiting requested review from come-nc

@icewind1991 icewind1991 Awaiting requested review from icewind1991

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

3. to review bug feature: webhooks manual: admin

Projects

None yet

Milestone

Nextcloud 33

Development

Successfully merging this pull request may close these issues.

[Bug]: NodeDeletedEvent webhook missing node.id field

3 participants

@joshtrichards @marcelklehr