3.1 KiB
3.1 KiB
stage | group | info |
---|---|---|
none | unassigned | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers |
System hooks API
All methods require administrator authorization.
The URL endpoint of the system hooks can also be configured using the UI in
the Admin Area > System Hooks (/admin/hooks
).
Read more about system hooks.
List system hooks
Get a list of all system hooks.
GET /hooks
Example request:
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/hooks"
Example response:
[
{
"id":1,
"url":"https://gitlab.example.com/hook",
"created_at":"2016-10-31T12:32:15.192Z",
"push_events":true,
"tag_push_events":false,
"merge_requests_events": true,
"repository_update_events": true,
"enable_ssl_verification":true
}
]
Add new system hook
Add a new system hook.
POST /hooks
Attribute | Type | Required | Description |
---|---|---|---|
url |
string | yes | The hook URL |
token |
string | no | Secret token to validate received payloads; this isn't returned in the response |
push_events |
boolean | no | When true, the hook fires on push events |
tag_push_events |
boolean | no | When true, the hook fires on new tags being pushed |
merge_requests_events |
boolean | no | Trigger hook on merge requests events |
repository_update_events |
boolean | no | Trigger hook on repository update events |
enable_ssl_verification |
boolean | no | Do SSL verification when triggering the hook |
Example request:
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/hooks?url=https://gitlab.example.com/hook"
Example response:
[
{
"id":1,
"url":"https://gitlab.example.com/hook",
"created_at":"2016-10-31T12:32:15.192Z",
"push_events":true,
"tag_push_events":false,
"merge_requests_events": true,
"repository_update_events": true,
"enable_ssl_verification":true
}
]
Test system hook
GET /hooks/:id
Attribute | Type | Required | Description |
---|---|---|---|
id |
integer | yes | The ID of the hook |
Example request:
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/hooks/2"
Example response:
{
"project_id" : 1,
"owner_email" : "example@gitlabhq.com",
"owner_name" : "Someone",
"name" : "Ruby",
"path" : "ruby",
"event_name" : "project_create"
}
Delete system hook
Deletes a system hook.
DELETE /hooks/:id
Attribute | Type | Required | Description |
---|---|---|---|
id |
integer | yes | The ID of the hook |
Example request:
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/hooks/2"