Improve Group Webhooks documentation
Problem to solve
Group webhooks lack any direct documentation.
When searching around, the only references to the ability to add webhooks to a group are:
- In our feature listing page: https://about.gitlab.com/pricing/self-managed/feature-comparison/
- On the API docs: https://docs.gitlab.com/ee/api/groups.html#hooks
- On the Webhooks page, almost as an afterthought: https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#overview
I think the reason for the lack of information is simply that a group webook is a shortcut to setting a bunch of the same webhook on all the projects in the group. Since the functionality is a parity, we didn't bother documenting it (much.)
However, it leaves me with some open questions:
- Are hooks available for group activity like added/removed members or projects? (no, there isn't)
- Does a hook added at the group act the same as if it was added directly to that project? (i think so, but unclear)
- Are the configuration options at the group level the same as at the project level?
- What happens if a project sets up the same webhook as well? Does it get called twice, does it override the group one? (
🤷 ) - There's a limit to the number of webhooks a project can have. Do group webhooks count against that limit? (e.g. if I already have 100 webhooks on a project, do the Group hooks fire? If I already have 50 group hooks, do only the first 50 project hooks fire? Neither, either, or?)
We might not want to document all of this, but I think having a clearer sense of what group webhooks are and what they do would help me better understand the feature.
Further details
Proposal
Who can address the issue
Other links/references
/cc @mikelewis
Edited by Patrick Deuley