GIgitlab
hooks

List all system hooks

Lists all system hooks for the instance.

get/api/v4/hooks

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Query parameters

pageinteger

Current page number

per_pageinteger

Number of items per page

Response

List all system hooks

idinteger required
urlstring required
namestring required
descriptionstring required
created_atstring date-time required
push_eventsboolean required
tag_push_eventsboolean required
merge_requests_eventsboolean required
repository_update_eventsboolean required
enable_ssl_verificationboolean required
organization_idinteger
alert_statusstring required
disabled_untilstring date-time required
url_variablesobject[]
push_events_branch_filterstring required
branch_filter_strategystring required
custom_webhook_templatestring required
custom_headersobject[]
token_presentboolean required

Whether a secret token is configured

signing_token_presentboolean required

Whether an HMAC signing token is configured

Example response

[
  {
    "id": 1,
    "url": "https://webhook.site",
    "name": "Hook name",
    "description": "Hook description",
    "created_at": "2012-05-28T04:42:42-07:00",
    "organization_id": 1,
    "alert_status": "executable",
    "disabled_until": "2012-05-28T04:42:42-07:00",
    "url_variables": [
      {
        "token": "secr3t"
      }
    ],
    "push_events_branch_filter": "my-branch-*",
    "branch_filter_strategy": "wildcard",
    "custom_webhook_template": "{\"event\":\"{{object_kind}}\"}",
    "custom_headers": [
      {
        "X-Custom-Header": "value"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.