-
Notifications
You must be signed in to change notification settings - Fork 138
Open
Labels
Description
There appears to be no consolidated guide/howto for use of the SCM notification webhooks. While they are included in the API docs these aren't really traditional API and seem they should be documented in the main documentation.
Suggested content
- at least with links to the API docs to avoid repeating ourselves
- explain why you might want to use this (it's often a suggestions to alleviate polling load/throttling on target VCS systems and take load off the material subsystem threads (and even H2) so it'd be nice to have something to point to
- link from Configuration / Add Material perhaps?
- As suggested at Support push webhooks with multiple changes gocd#10091 (comment) perhaps it should also note how to disable polling on materials.
- the
config_reposwebhooks added in21.1.0in #8023 seem to not be documented at all; this documentation should probably include mention of that, or build on top of Document the webhooks for config repo material notifications api.go.cd#1037