summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2016-11-03 16:05:40 +0000
committerRémy Coutable <remy@rymai.me>2016-11-03 16:05:40 +0000
commitd8153e31257c7a0ddc6123cc1a7d893a16e1b87a (patch)
tree0cefd42a039c646b930655742f57f627e7d112c0 /doc
parentd54f3a10efa7f40b4368cb19fe32c98804d6c0bd (diff)
parent37f229c7358a48c6a9af3481927e9e4faee17e3d (diff)
downloadgitlab-ce-d8153e31257c7a0ddc6123cc1a7d893a16e1b87a.tar.gz
Merge branch 'zj-expose-system-hooks' into 'master'
Expose more info for SystemHooks See merge request !6964
Diffstat (limited to 'doc')
-rw-r--r--doc/api/system_hooks.md30
1 files changed, 20 insertions, 10 deletions
diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md
index 073e99b7147..efd23d514bc 100644
--- a/doc/api/system_hooks.md
+++ b/doc/api/system_hooks.md
@@ -27,11 +27,14 @@ Example response:
```json
[
- {
- "id" : 1,
- "url" : "https://gitlab.example.com/hook",
- "created_at" : "2015-11-04T20:07:35.874Z"
- }
+ {
+ "id":1,
+ "url":"https://gitlab.example.com/hook",
+ "created_at":"2016-10-31T12:32:15.192Z",
+ "push_events":true,
+ "tag_push_events":false,
+ "enable_ssl_verification":true
+ }
]
```
@@ -48,6 +51,10 @@ POST /hooks
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | yes | The hook URL |
+| `token` | string | no | Secret token to validate received payloads; this will not be returned in the response |
+| `push_events` | boolean | no | When true, the hook will fire on push events |
+| `tag_push_events` | boolean | no | When true, the hook will fire on new tags being pushed |
+| `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook |
Example request:
@@ -59,11 +66,14 @@ Example response:
```json
[
- {
- "id" : 2,
- "url" : "https://gitlab.example.com/hook",
- "created_at" : "2015-11-04T20:07:35.874Z"
- }
+ {
+ "id":1,
+ "url":"https://gitlab.example.com/hook",
+ "created_at":"2016-10-31T12:32:15.192Z",
+ "push_events":true,
+ "tag_push_events":false,
+ "enable_ssl_verification":true
+ }
]
```