summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-06-27 20:26:41 +0200
committerGitHub <noreply@github.com>2021-06-27 20:26:41 +0200
commit6abf13a7e25e368da342e7d1da6cfc19915c2dfd (patch)
tree260ab3034ff8a51dcfcb5d56805d1120dcd02f71 /docs
parent33d342818599f403434e7024097449b6f21babc0 (diff)
parent953f207466c53c28a877f2a88da9160acef40643 (diff)
downloadgitlab-6abf13a7e25e368da342e7d1da6cfc19915c2dfd.tar.gz
Merge pull request #1533 from sugonyak/add-group-hooks
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()