WebHooks for XWiki
Last modified by Vincent Massol on 2022/02/25 10:21
- Mentor(s)
- Estimated workload
175 hours (Medium size project)
- Difficulty
Medium
- Details
XWiki supports Events for various actions done in the XWiki: creating a new page, modifying a page, doing an action, etc. It's possible to write Event Listeners in Java or in Wiki pages.
However it would be great to be able to register Web Hooks in XWiki so that events would trigger Web Hooks, i.e. call remote APIs to notify them about the event that has just happened.
Goals & Ideas
- Provide something similar to GitLab's System Hooks and Web Hooks.
- Write a generic Event Listener that listens to all events and forward them as remote API calls when events occur.
- Also provide an Admin UI so that users can register URLs for specific events.
- Implement this as a Contrib Extension and release it
The JIRA issue corresponding to this need is XWIKI-16088.
- Developer profile
Useful Technologies:
- Java
- Maven
- Velocity
- Active
- Yes
- Year
2022
- Status
Proposed
