이 API를 사용하여 시스템 훅을 관리합니다. 시스템 훅은 그룹 내 모든 프로젝트와 하위 그룹에 영향을 주는 그룹 웹훅, 단일 프로젝트로 범위가 한정되는 프로젝트 웹훅과는 다릅니다.

사전 요구 사항:

• 관리자여야 합니다.

모든 시스템 훅 조회#

모든 시스템 훅을 조회합니다.

GET /hooks

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/hooks"

응답 예시:

[
  {
    "id":1,
    "url":"https://gitlab.example.com/hook",
    "name": "Hook name",
    "description": "Hook description",
    "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,
    "organization_id": 1,
    "alert_status": "executable",
    "disabled_until": null,
    "url_variables": [],
    "push_events_branch_filter": "",
    "branch_filter_strategy": "wildcard",
    "custom_webhook_template": "{\"event\":\"{{object_kind}}\"}",
    "custom_headers": [
      {
        "key": "X-Custom-Header"
      }
    ],
    "token_present": false,
    "signing_token_present": false
  }
]

시스템 훅 상세 조회#

히스토리

• name 및 description 속성이 GitLab 17.1에서 도입되었습니다.
• token_present 및 signing_token_present 속성이 GitLab 19.0에서 도입되었습니다.

ID로 시스템 훅을 조회합니다.

GET /hooks/:id

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/hooks/1"

응답 예시:

{
  "id": 1,
  "url": "https://gitlab.example.com/hook",
  "name": "Hook name",
  "description": "Hook description",
  "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,
  "organization_id": 1,
  "alert_status": "executable",
  "disabled_until": null,
  "url_variables": [],
  "push_events_branch_filter": "",
  "branch_filter_strategy": "wildcard",
  "custom_webhook_template": "{\"event\":\"{{object_kind}}\"}",
  "custom_headers": [
    {
      "key": "X-Custom-Header"
    }
  ],
  "token_present": false,
  "signing_token_present": false
}

새 시스템 훅 추가#

히스토리

• name 및 description 속성이 GitLab 17.1에서 도입되었습니다.
• signing_token 속성이 GitLab 19.0에서 webhook_signing_token 기능 플래그와 함께 도입되었습니다. 기본값은 활성화입니다.
• 기능 플래그 webhook_signing_token 이 GitLab 19.1에서 제거되었습니다.

새 시스템 훅을 추가합니다.

POST /hooks

요청 예시:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/hooks?url=https://gitlab.example.com/hook"

응답 예시:

[
  {
    "id":1,
    "url":"https://gitlab.example.com/hook",
    "name": "Hook name",
    "description": "Hook description",
    "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,
    "organization_id": 1,
    "alert_status": "executable",
    "disabled_until": null,
    "url_variables": [],
    "push_events_branch_filter": "",
    "branch_filter_strategy": "wildcard",
    "custom_webhook_template": "{\"event\":\"{{object_kind}}\"}",
    "custom_headers": [
      {
        "key": "X-Custom-Header"
      }
    ],
    "token_present": false,
    "signing_token_present": false
  }
]

시스템 훅 업데이트#

히스토리

• name 및 description 속성이 GitLab 17.1에서 도입되었습니다.
• signing_token 속성이 GitLab 19.0에서 webhook_signing_token 기능 플래그와 함께 도입되었습니다. 기본값은 활성화입니다.
• 기능 플래그 webhook_signing_token 이 GitLab 19.1에서 제거되었습니다.

기존 시스템 훅을 업데이트합니다.

PUT /hooks/:hook_id

시스템 훅 테스트#

모의 데이터로 시스템 훅을 실행합니다.

POST /hooks/:id

요청 예시:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/hooks/1"

응답은 항상 다음과 같은 모의 데이터입니다.

{
   "project_id" : 1,
   "owner_email" : "example@gitlabhq.com",
   "owner_name" : "Someone",
   "name" : "Ruby",
   "path" : "ruby",
   "event_name" : "project_create"
}

시스템 훅 삭제#

시스템 훅을 삭제합니다.

DELETE /hooks/:id

요청 예시:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/hooks/2"

URL 변수 설정#

PUT /hooks/:hook_id/url_variables/:key

지원하는 속성은 다음과 같습니다.

성공하면 이 엔드포인트는 응답 코드 204 No Content를 반환합니다.

URL 변수 삭제#

DELETE /hooks/:hook_id/url_variables/:key

지원하는 속성은 다음과 같습니다.

성공하면 이 엔드포인트는 응답 코드 204 No Content를 반환합니다.