summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIvan Sugonyak <sugonyak.ivan@gmail.com>2021-06-25 20:49:04 +0300
committerIvan Sugonyak <sugonyak.ivan@gmail.com>2021-06-26 02:01:08 +0300
commit4a7e9b86aa348b72925bce3af1e5d988b8ce3439 (patch)
tree2ca75418bb4e5670f30ec5a3d2fe30447b83dc29 /docs
parentaf7aae73e90b54cab7bbf38a8575157416693423 (diff)
downloadgitlab-4a7e9b86aa348b72925bce3af1e5d988b8ce3439.tar.gz
feat(api): add group hooks
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/groups.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
index 596db0a..44fb11d 100644
--- a/docs/gl_objects/groups.rst
+++ b/docs/gl_objects/groups.rst
@@ -338,3 +338,43 @@ You can use the ``ldapgroups`` manager to list available LDAP groups::
# list the groups for a specific LDAP provider
ldap_groups = gl.ldapgroups.list(search='foo', provider='ldapmain')
+
+Groups hooks
+============
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.GroupHook`
+ + :class:`gitlab.v4.objects.GroupHookManager`
+ + :attr:`gitlab.v4.objects.Group.hooks`
+
+* GitLab API: https://docs.gitlab.com/ce/api/groups.html#hooks
+
+Examples
+--------
+
+List the group hooks::
+
+ hooks = group.hooks.list()
+
+Get a group hook::
+
+ hook = group.hooks.get(hook_id)
+
+Create a group hook::
+
+ hook = group.hooks.create({'url': 'http://my/action/url', 'push_events': 1})
+
+Update a group hook::
+
+ hook.push_events = 0
+ hook.save()
+
+Delete a group hook::
+
+ group.hooks.delete(hook_id)
+ # or
+ hook.delete()