debian-mirror-gitlab/doc/api/system_hooks.md

131 lines
2.7 KiB
Markdown
Raw Normal View History

2017-09-10 17:25:29 +05:30
# System hooks API
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
All methods require administrator authorization.
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
The URL endpoint of the system hooks can also be configured using the UI in
the admin area under **Hooks** (`/admin/hooks`).
Read more about [system hooks](../system_hooks/system_hooks.md).
2014-09-02 18:07:02 +05:30
## List system hooks
2016-04-02 18:10:28 +05:30
Get a list of all system hooks.
---
2014-09-02 18:07:02 +05:30
```
GET /hooks
```
2016-04-02 18:10:28 +05:30
Example request:
```bash
2017-08-17 22:00:37 +05:30
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/hooks
2016-04-02 18:10:28 +05:30
```
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
Example response:
2014-09-02 18:07:02 +05:30
```json
[
2017-08-17 22:00:37 +05:30
{
"id":1,
"url":"https://gitlab.example.com/hook",
"created_at":"2016-10-31T12:32:15.192Z",
"push_events":true,
"tag_push_events":false,
2018-03-17 18:26:18 +05:30
"merge_requests_events": true,
2017-08-17 22:00:37 +05:30
"enable_ssl_verification":true
}
2014-09-02 18:07:02 +05:30
]
```
2016-04-02 18:10:28 +05:30
## Add new system hook
Add a new system hook.
---
2014-09-02 18:07:02 +05:30
```
POST /hooks
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | yes | The hook URL |
2017-08-17 22:00:37 +05:30
| `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 |
2018-03-17 18:26:18 +05:30
| `merge_requests_events` | boolean | no | Trigger hook on merge requests events |
2017-08-17 22:00:37 +05:30
| `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook |
2016-04-02 18:10:28 +05:30
Example request:
```bash
2017-08-17 22:00:37 +05:30
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/hooks?url=https://gitlab.example.com/hook"
2016-04-02 18:10:28 +05:30
```
Example response:
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
```json
[
2017-08-17 22:00:37 +05:30
{
"id":1,
"url":"https://gitlab.example.com/hook",
"created_at":"2016-10-31T12:32:15.192Z",
"push_events":true,
"tag_push_events":false,
2018-03-17 18:26:18 +05:30
"merge_requests_events": true,
2017-08-17 22:00:37 +05:30
"enable_ssl_verification":true
}
2016-04-02 18:10:28 +05:30
]
```
2014-09-02 18:07:02 +05:30
## Test system hook
```
GET /hooks/:id
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of the hook |
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
Example request:
```bash
2017-08-17 22:00:37 +05:30
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/hooks/2
2016-04-02 18:10:28 +05:30
```
Example response:
2014-09-02 18:07:02 +05:30
```json
{
2016-04-02 18:10:28 +05:30
"project_id" : 1,
"owner_email" : "example@gitlabhq.com",
"owner_name" : "Someone",
"name" : "Ruby",
"path" : "ruby",
"event_name" : "project_create"
2014-09-02 18:07:02 +05:30
}
```
## Delete system hook
2017-08-17 22:00:37 +05:30
Deletes a system hook.
2016-04-02 18:10:28 +05:30
---
2014-09-02 18:07:02 +05:30
```
DELETE /hooks/:id
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of the hook |
Example request:
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
```bash
2017-08-17 22:00:37 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/hooks/2
2016-04-02 18:10:28 +05:30
```