With [#4542] we should have docs of how webhooks work (payload examples, secret validation, etc). Can be at https://sourceforge.net/p/forge/documentation/Allura%20API/ or a page in this project's wiki.
Looks like there are some docstrings already for the new webhook classes. We should update Allura/docs/api/ to include them too. (End-user documentation is still the main goal of this ticket, however)
Payload examples should be given for each of Git, Hg, and SVN since they do vary somewhat.
Closed #732. ib/7829
+ [Webhooks] page and link to it from [Home]
TODO: add API docs from #7832 to https://sourceforge.net/p/forge/documentation/Allura%20API/ when it's closed
Nice. I only made a few minor edits to grammar and formatting.
Thanks! While reviewing the diff I've made another edit
Did you forgot to merge ib/7829? (adds webhooks stuff to Allura/docs/api/)
Thanks for catching that. I missed that altogether. Merged now. (Plus added a link in extending.rst)
Log in to post a comment.