docs/gl_objects/system_hooks.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

############
System hooks
############

Reference
---------

* v4 API:

  + :class:`gitlab.v4.objects.Hook`
  + :class:`gitlab.v4.objects.HookManager`
  + :attr:`gitlab.Gitlab.hooks`

* GitLab API: https://docs.gitlab.com/ce/api/system_hooks.html

Examples
--------

List the system hooks::

    hooks = gl.hooks.list()

Create a system hook::

    gl.hooks.get(hook_id)

Test a system hook. The returned object is not usable (it misses the hook ID)::

    hook = gl.hooks.create({'url': 'http://your.target.url'})

Delete a system hook::

    gl.hooks.delete(hook_id)
    # or
    hook.delete()