GitSwarm-EE 2017.1-1 Documentation

System hooks

System hooks

All methods require administrator authorization.

The URL endpoint of the system hooks can also be configured using the UI in the admin area under Hooks (/admin/hooks).

List system hooks

Get a list of all system hooks.

GET /hooks

Example request:

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitswarm.example.com/api/v3/hooks

Example response:

[
  {
    "id":1,
    "url":"https://gitswarm.example.com/hook",
    "created_at":"2016-10-31T12:32:15.192Z",
    "push_events":true,
    "tag_push_events":false,
    "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 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:

curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitswarm.example.com/api/v3/hooks?url=https://gitswarm.example.com/hook"

Example response:

[
  {
    "id":1,
    "url":"https://gitswarm.example.com/hook",
    "created_at":"2016-10-31T12:32:15.192Z",
    "push_events":true,
    "tag_push_events":false,
    "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: 9koXpg98eAheJpvBs5tK" https://gitswarm.example.com/api/v3/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. It returns 200 OK if the hooks is deleted and 404 Not Found if the hook is not found.

DELETE /hooks/:id

Attribute	Type	Required	Description
`id`	integer	yes	The ID of the hook

Example request:

curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitswarm.example.com/api/v3/hooks/2

Example response:

{
   "note_events" : false,
   "project_id" : null,
   "enable_ssl_verification" : true,
   "url" : "https://gitswarm.example.com/hook",
   "updated_at" : "2015-11-04T20:12:15.931Z",
   "issues_events" : false,
   "merge_requests_events" : false,
   "created_at" : "2015-11-04T20:12:15.931Z",
   "service_id" : null,
   "id" : 2,
   "push_events" : true,
   "tag_push_events" : false
}