Skip to content

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

Open
joshtrichards wants to merge 3 commits intomasterfrom
jtr/admin-webhook-fix-payloads
Open

fix: correct/improve webhook listener event descriptions and examples#13853
joshtrichards wants to merge 3 commits intomasterfrom
jtr/admin-webhook-fix-payloads

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.
  • Mention occ command

Still some follow-up items but this is enough for this particular PR. Ideas for future PR(s):

  • OCS
    • registration
    • auth
    • ephemeral tokens
  • AppAPI / ExApp integration/support
  • MapperEvent & IWebHookCompatibleEvent
  • curl / OCS API request/response example

🖼️ Screenshots

image

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 <josh.t.richards@gmail.com>
"id": 437,
"path": "/admin/files/test-webhook.txt"
}
}
Copy link
Member

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?

Copy link
Member Author

Choose a reason for hiding this comment

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

Indeed. Oops. Fixed all the payloads. Thanks and apologies for the delay.

@marcelklehr
Copy link
Member

Looks really good! Thank you @joshtrichards 💙 !

@blizzz blizzz modified the milestones: Nextcloud 33, Nextcloud 34 Feb 16, 2026
…ators

Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh Richards <josh.t.richards@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: NodeDeletedEvent webhook missing node.id field

3 participants