正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

グループWebhook API

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用してグループのWebhookを管理します。グループのWebhookは、インスタンス全体に影響を与えるシステムフックや、単一のプロジェクトに限定されるプロジェクトWebhookとは異なります。

前提条件:

  • 管理者であるか、グループのオーナーロールを持っている必要があります。

すべてのグループフックをリスト表示

指定されたグループのすべてのグループフックをリスト表示します。

GET /groups/:id/hooks

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス。

リクエスト例:

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

レスポンス例:

[
  {
    "id": 1,
    "url": "http://example.com/hook",
    "name": "Test group hook",
    "description": "This is a test group hook.",
    "created_at": "2024-09-01T09:10:54.854Z",
    "push_events": true,
    "tag_push_events": false,
    "merge_requests_events": false,
    "repository_update_events": false,
    "enable_ssl_verification": true,
    "alert_status": "executable",
    "disabled_until": null,
    "url_variables": [],
    "push_events_branch_filter": null,
    "branch_filter_strategy": "all_branches",
    "group_id": 99,
    "issues_events": false,
    "confidential_issues_events": false,
    "note_events": false,
    "confidential_note_events": false,
    "pipeline_events": false,
    "wiki_page_events": false,
    "job_events": false,
    "deployment_events": false,
    "feature_flag_events": false,
    "releases_events": false,
    "milestone_events": false,
    "subgroup_events": false,
    "emoji_events": false,
    "resource_access_token_events": false,
    "member_events": false,
    "project_events": false,
    "custom_webhook_template": "{\"event\":\"{{object_kind}}\"}",
    "custom_headers": [
      {
        "key": "Authorization"
      }
    ],
    "token_present": false,
    "signing_token_present": false
  }
]

グループフックを取得する

指定されたグループフックを取得します。

GET /groups/:id/hooks/:hook_id

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
hook_id整数はいグループフックのID。

リクエスト例:

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

レスポンス例:

{
  "id": 1,
  "url": "http://example.com/hook",
  "name": "Hook name",
  "description": "Hook description",
  "group_id": 3,
  "push_events": true,
  "push_events_branch_filter": "",
  "branch_filter_strategy": "wildcard",
  "issues_events": true,
  "confidential_issues_events": true,
  "merge_requests_events": true,
  "tag_push_events": true,
  "note_events": true,
  "confidential_note_events": true,
  "job_events": true,
  "pipeline_events": true,
  "wiki_page_events": true,
  "deployment_events": true,
  "feature_flag_events": false,
  "releases_events": true,
  "milestone_events": false,
  "subgroup_events": true,
  "member_events": true,
  "project_events": true,
  "enable_ssl_verification": true,
  "repository_update_events": false,
  "alert_status": "executable",
  "disabled_until": null,
  "url_variables": [ ],
  "created_at": "2012-10-12T17:04:47Z",
  "resource_access_token_events": true,
  "custom_webhook_template": "{\"event\":\"{{object_kind}}\"}",
  "custom_headers": [
    {
      "key": "Authorization"
    }
  ],
  "token_present": false,
  "signing_token_present": false
}

すべてのグループフックイベントをリスト表示

指定されたグループフックの、開始日から過去7日間のすべてのイベントをリスト表示します。

GET /groups/:id/hooks/:hook_id/events

サポートされている属性は以下のとおりです:

属性型必須説明
hook_id整数はいプロジェクトフックのID。
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
page整数いいえ取得するページ。1がデフォルトです。
per_page整数いいえページごとに返すレコード数。20がデフォルトです。
status整数または文字列いいえイベントのレスポンスステータスコード。例: 200または500。ステータスカテゴリで検索できます: successful (200-299)、client_failure (400-499)、およびserver_failure (500-599)。

リクエスト例:

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

レスポンス例:

[
  {
    "id": 1,
    "url": "https://example.net/",
    "trigger": "push_hooks",
    "request_headers": {
      "Content-Type": "application/json",
      "User-Agent": "GitLab/17.1.0-pre",
      "Idempotency-Key": "a5461c4d-9c7f-4af9-add6-cddebe3c426f",
      "X-Gitlab-Event": "Push Hook",
      "X-Gitlab-Webhook-UUID": "3c5c0404-c866-44bc-a5f6-452bb1bfc76e",
      "X-Gitlab-Instance": "https://gitlab.example.com",
      "X-Gitlab-Event-UUID": "9cebe914-4827-408f-b014-cfa23a47a35f",
      "X-Gitlab-Token": "[REDACTED]"
    },
    "request_data": {
      "object_kind": "push",
      "event_name": "push",
      "after": "f15b32277d2c55c6c595845a87109b09c913c556",
      "ref": "refs/heads/master",
      "ref_protected": true,
      "checkout_sha": "f15b32277d2c55c6c595845a87109b09c913c556",
      "message": null,
      "user_id": 1,
      "user_name": "Administrator",
      "user_username": "root",
      "user_email": null,
      "user_avatar": "https://www.gravatar.com/avatar/13efe0d4559475ba84ecc802061febbdea6e224fcbffd7ec7da9cd431845299c?s=80&d=identicon",
      "project_id": 7,
      "project": {
        "id": 7,
        "name": "Flight",
        "description": "Incidunt ea ab officia a veniam.",
        "web_url": "https://gitlab.example.com/flightjs/Flight",
        "avatar_url": null,
        "git_ssh_url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "git_http_url": "https://gitlab.example.com/flightjs/Flight.git",
        "namespace": "Flightjs",
        "visibility_level": 10,
        "path_with_namespace": "flightjs/Flight",
        "default_branch": "master",
        "ci_config_path": null,
        "homepage": "https://gitlab.example.com/flightjs/Flight",
        "url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "ssh_url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "http_url": "https://gitlab.example.com/flightjs/Flight.git"
      },
      "commits": [
        {
          "id": "f15b32277d2c55c6c595845a87109b09c913c556",
          "message": "v1.5.2\n",
          "title": "v1.5.2",
          "timestamp": "2017-06-19T14:39:53-07:00",
          "url": "https://gitlab.example.com/flightjs/Flight/-/commit/f15b32277d2c55c6c595845a87109b09c913c556",
          "author": {
            "name": "Andrew Lunny",
            "email": "[REDACTED]"
          },
          "added": [],
          "modified": [
            "package.json"
          ],
          "removed": []
        },
        {
          "id": "8749d49930866a4871fa086adbd7d2057fcc3ebb",
          "message": "Merge pull request #378 from flightjs/alunny/publish_lib\n\npublish lib and index to npm",
          "title": "Merge pull request #378 from flightjs/alunny/publish_lib",
          "timestamp": "2017-06-16T10:26:39-07:00",
          "url": "https://gitlab.example.com/flightjs/Flight/-/commit/8749d49930866a4871fa086adbd7d2057fcc3ebb",
          "author": {
            "name": "angus croll",
            "email": "[REDACTED]"
          },
          "added": [],
          "modified": [
            "package.json"
          ],
          "removed": []
        },
        {
          "id": "468abc807a2b2572f43e72c743b76cee6db24025",
          "message": "publish lib and index to npm\n",
          "title": "publish lib and index to npm",
          "timestamp": "2017-06-16T10:23:04-07:00",
          "url": "https://gitlab.example.com/flightjs/Flight/-/commit/468abc807a2b2572f43e72c743b76cee6db24025",
          "author": {
            "name": "Andrew Lunny",
            "email": "[REDACTED]"
          },
          "added": [],
          "modified": [
            "package.json"
          ],
          "removed": []
        }
      ],
      "total_commits_count": 3,
      "push_options": {},
      "repository": {
        "name": "Flight",
        "url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "description": "Incidunt ea ab officia a veniam.",
        "homepage": "https://gitlab.example.com/flightjs/Flight",
        "git_http_url": "https://gitlab.example.com/flightjs/Flight.git",
        "git_ssh_url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "visibility_level": 10
      }
    },
    "response_headers": {
      "Date": "Sun, 26 May 2024 03:03:17 GMT",
      "Content-Type": "application/json; charset=utf-8",
      "Content-Length": "16",
      "Connection": "close",
      "X-Powered-By": "Express",
      "Access-Control-Allow-Origin": "*",
      "X-Pd-Status": "sent to primary"
    },
    "response_body": "{\"success\":true}",
    "execution_duration": 1.0906479999999874,
    "response_status": "200"
  },
  {
    "id": 2,
    "url": "https://example.net/",
    "trigger": "push_hooks",
    "request_headers": {
      "Content-Type": "application/json",
      "User-Agent": "GitLab/17.1.0-pre",
      "Idempotency-Key": "1f0a54f0-0529-408d-a5b8-a2a98ff5f94a",
      "X-Gitlab-Event": "Push Hook",
      "X-Gitlab-Webhook-UUID": "a753eedb-1d72-4549-9ca7-eac8ea8e50dd",
      "X-Gitlab-Instance": "https://gitlab.example.com:3000",
      "X-Gitlab-Event-UUID": "842d7c3e-3114-4396-8a95-66c084d53cb1",
      "X-Gitlab-Token": "[REDACTED]"
    },
    "request_data": {
      "object_kind": "push",
      "event_name": "push",
      "before": "468abc807a2b2572f43e72c743b76cee6db24025",
      "after": "f15b32277d2c55c6c595845a87109b09c913c556",
      "ref": "refs/heads/master",
      "ref_protected": true,
      "checkout_sha": "f15b32277d2c55c6c595845a87109b09c913c556",
      "message": null,
      "user_id": 1,
      "user_name": "Administrator",
      "user_username": "root",
      "user_email": null,
      "user_avatar": "https://www.gravatar.com/avatar/13efe0d4559475ba84ecc802061febbdea6e224fcbffd7ec7da9cd431845299c?s=80&d=identicon",
      "project_id": 7,
      "project": {
        "id": 7,
        "name": "Flight",
        "description": "Incidunt ea ab officia a veniam.",
        "web_url": "https://gitlab.example.com/flightjs/Flight",
        "avatar_url": null,
        "git_ssh_url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "git_http_url": "https://gitlab.example.com/flightjs/Flight.git",
        "namespace": "Flightjs",
        "visibility_level": 10,
        "path_with_namespace": "flightjs/Flight",
        "default_branch": "master",
        "ci_config_path": null,
        "homepage": "https://gitlab.example.com/flightjs/Flight",
        "url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "ssh_url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "http_url": "https://gitlab.example.com/flightjs/Flight.git"
      },
      "commits": [
        {
          "id": "f15b32277d2c55c6c595845a87109b09c913c556",
          "message": "v1.5.2\n",
          "title": "v1.5.2",
          "timestamp": "2017-06-19T14:39:53-07:00",
          "url": "https://gitlab.example.com/flightjs/Flight/-/commit/f15b32277d2c55c6c595845a87109b09c913c556",
          "author": {
            "name": "Andrew Lunny",
            "email": "[REDACTED]"
          },
          "added": [],
          "modified": [
            "package.json"
          ],
          "removed": []
        },
        {
          "id": "8749d49930866a4871fa086adbd7d2057fcc3ebb",
          "message": "Merge pull request #378 from flightjs/alunny/publish_lib\n\npublish lib and index to npm",
          "title": "Merge pull request #378 from flightjs/alunny/publish_lib",
          "timestamp": "2017-06-16T10:26:39-07:00",
          "url": "https://gitlab.example.com/flightjs/Flight/-/commit/8749d49930866a4871fa086adbd7d2057fcc3ebb",
          "author": {
            "name": "angus croll",
            "email": "[REDACTED]"
          },
          "added": [],
          "modified": [
            "package.json"
          ],
          "removed": []
        },
        {
          "id": "468abc807a2b2572f43e72c743b76cee6db24025",
          "message": "publish lib and index to npm\n",
          "title": "publish lib and index to npm",
          "timestamp": "2017-06-16T10:23:04-07:00",
          "url": "https://gitlab.example.com/flightjs/Flight/-/commit/468abc807a2b2572f43e72c743b76cee6db24025",
          "author": {
            "name": "Andrew Lunny",
            "email": "[REDACTED]"
          },
          "added": [],
          "modified": [
            "package.json"
          ],
          "removed": []
        }
      ],
      "total_commits_count": 3,
      "push_options": {},
      "repository": {
        "name": "Flight",
        "url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "description": "Incidunt ea ab officia a veniam.",
        "homepage": "https://gitlab.example.com/flightjs/Flight",
        "git_http_url": "https://gitlab.example.com/flightjs/Flight.git",
        "git_ssh_url": "ssh://git@gitlab.example.com:2222/flightjs/Flight.git",
        "visibility_level": 10
      }
    },
    "response_headers": {
      "Date": "Sun, 26 May 2024 03:03:19 GMT",
      "Content-Type": "application/json; charset=utf-8",
      "Content-Length": "16",
      "Connection": "close",
      "X-Powered-By": "Express",
      "Access-Control-Allow-Origin": "*",
      "X-Pd-Status": "sent to primary"
    },
    "response_body": "{\"success\":true}",
    "execution_duration": 1.0716120000000728,
    "response_status": "200"
  }
]

グループフックイベントを再送

特定のフックイベントを再送します。

このエンドポイントには、フックと認証済みユーザーごとに1分あたり5リクエストのレート制限があります。GitLab Self-ManagedおよびGitLab Dedicatedでこの制限を無効にするには、管理者がweb_hook_event_resend_api_endpoint_rate_limitという名前の機能フラグを無効にできます。

POST /groups/:id/hooks/:hook_id/events/:hook_event_id/resend

サポートされている属性は以下のとおりです:

属性型必須説明
hook_event_id整数はいフックイベントのID。
hook_id整数はいグループフックのID。
id整数または文字列はいグループのIDまたはURLエンコードされたパス。

リクエスト例:

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

レスポンス例:

{
  "response_status": 200
}

グループフックを作成

指定されたグループのグループフックを作成します。

POST /groups/:id/hooks

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
url文字列はいフックのURL。
branch_filter_strategy文字列いいえブランチでプッシュイベントをフィルタリングします指定できる値は、wildcard（デフォルト）、regex、およびall_branchesです。
confidential_issues_eventsブール値いいえ機密イシューイベントでフックをトリガーします。
confidential_note_eventsブール値いいえ機密ノートイベントでフックをトリガーします。
custom_headers配列いいえフックのカスタムヘッダー。
custom_webhook_template文字列いいえフックのカスタムWebhookテンプレート。
deployment_eventsブール値いいえデプロイイベントでフックをトリガーします。
description文字列いいえフックの説明（GitLab 17.1で導入）。
enable_ssl_verificationブール値いいえフックをトリガーするときにSSL検証を実行します。
feature_flag_eventsブール値いいえ機能フラグイベントでフックをトリガーします。
issues_eventsブール値いいえイシューイベントでフックをトリガーします。
job_eventsブール値いいえジョブイベントでフックをトリガーします。
member_eventsブール値いいえメンバーイベントでフックをトリガーします。
merge_requests_eventsブール値いいえマージリクエストイベントでフックをトリガーします。
milestone_eventsブール値いいえマイルストーンイベントでフックをトリガーします。
name文字列いいえフックの名前（GitLab 17.1で導入）。
note_eventsブール値いいえノートイベントでフックをトリガーします。
pipeline_eventsブール値いいえパイプラインイベントでフックをトリガーします。
project_eventsブール値いいえプロジェクトイベントでフックをトリガーします。
push_eventsブール値いいえプッシュイベントでフックをトリガーします。
push_events_branch_filter文字列いいえ一致するブランチのプッシュイベントでのみフックをトリガーします。
releases_eventsブール値いいえリリースイベントでフックをトリガーします。
resource_access_token_eventsブール値いいえプロジェクトアクセストークンの有効期限イベントでフックをトリガーします。
signing_token文字列いいえwebhook-signatureヘッダーをコンピューティングするために使用されるHMAC署名トークン。32バイトのキーをエンコードするwhsec_<base64>形式である必要があります。レスポンスでは返されません。
subgroup_eventsブール値いいえサブグループイベントでフックをトリガーします。
tag_push_eventsブール値いいえタグプッシュイベントでフックをトリガーします。
token文字列いいえ受信したペイロードを検証するためのシークレットトークン。レスポンスでは返されません。
wiki_page_eventsブール値いいえWikiページイベントでフックをトリガーします。

リクエスト例:

curl --request POST \
  --header "content-type: application/json" \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/3/hooks" \
  --data '{"url": "https://example.com/hook", "name": "My Hook", "description": "Hook description"}'

レスポンス例:

{
  "id": 42,
  "url": "https://example.com/hook",
  "name": "My Hook",
  "description": "Hook description",
  "group_id": 3,
  "push_events": true,
  "push_events_branch_filter": "",
  "branch_filter_strategy": "wildcard",
  "issues_events": true,
  "confidential_issues_events": true,
  "merge_requests_events": true,
  "tag_push_events": true,
  "note_events": true,
  "confidential_note_events": true,
  "job_events": true,
  "pipeline_events": true,
  "wiki_page_events": true,
  "deployment_events": true,
  "feature_flag_events": true,
  "releases_events": true,
  "milestone_events": true,
  "subgroup_events": true,
  "member_events": true,
  "project_events": true,
  "enable_ssl_verification": true,
  "repository_update_events": false,
  "alert_status": "executable",
  "disabled_until": null,
  "url_variables": [ ],
  "created_at": "2012-10-12T17:04:47Z",
  "resource_access_token_events": true,
  "custom_webhook_template": "{\"event\":\"{{object_kind}}\"}",
  "token_present": false,
  "signing_token_present": false
}

グループフックを更新

指定されたグループのグループフックを更新します。

PUT /groups/:id/hooks/:hook_id

サポートされている属性は以下のとおりです:

属性型必須説明
hook_id整数はいグループフックのID。
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
url文字列はいフックのURL。
branch_filter_strategy文字列いいえブランチでプッシュイベントをフィルタリングします指定できる値は、wildcard（デフォルト）、regex、およびall_branchesです。
confidential_issues_eventsブール値いいえ機密イシューイベントでフックをトリガーします。
confidential_note_eventsブール値いいえ機密ノートイベントでフックをトリガーします。
custom_headers配列いいえフックのカスタムヘッダー。
custom_webhook_template文字列いいえフックのカスタムWebhookテンプレート。
deployment_eventsブール値いいえデプロイイベントでフックをトリガーします。
description文字列いいえフックの説明。
enable_ssl_verificationブール値いいえフックをトリガーするときにSSL検証を実行します。
feature_flag_eventsブール値いいえ機能フラグイベントでフックをトリガーします。
issues_eventsブール値いいえイシューイベントでフックをトリガーします。
job_eventsブール値いいえジョブイベントでフックをトリガーします。
member_eventsブール値いいえメンバーイベントでフックをトリガーします。
merge_requests_eventsブール値いいえマージリクエストイベントでフックをトリガーします。
milestone_eventsブール値いいえマイルストーンイベントでフックをトリガーします。
name文字列いいえフックの名前。
note_eventsブール値いいえノートイベントでフックをトリガーします。
pipeline_eventsブール値いいえパイプラインイベントでフックをトリガーします。
project_eventsブール値いいえプロジェクトイベントでフックをトリガーします。
push_eventsブール値いいえプッシュイベントでフックをトリガーします。
push_events_branch_filter文字列いいえ一致するブランチのプッシュイベントでのみフックをトリガーします。
releases_eventsブール値いいえリリースイベントでフックをトリガーします。
resource_access_token_eventsブール値いいえプロジェクトアクセストークンの有効期限イベントでフックをトリガーします。
service_access_tokens_expiration_enforcedブール値いいえサービスアカウントのアクセストークンに有効期限日を設定する必要があります。
signing_token文字列いいえwebhook-signatureヘッダーをコンピューティングするために使用されるHMAC署名トークン。32バイトのキーをエンコードするwhsec_<base64>形式である必要があります。レスポンスでは返されません。
subgroup_eventsブール値いいえサブグループイベントでフックをトリガーします。
tag_push_eventsブール値いいえタグプッシュイベントでフックをトリガーします。
token文字列いいえ受信したペイロードを検証するためのシークレットトークン。レスポンスでは返されません。Webhook URLを変更すると、シークレットトークンはリセットされ、保持されません。
wiki_page_eventsブール値いいえWikiページイベントでフックをトリガーします。

リクエスト例:

curl --request POST \
  --header "content-type: application/json" \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/3/hooks/1" \
  --data '{"url": "https://example.com/hook", "name": "New hook name", "description": "Changed hook description"}'

レスポンス例:

{
  "id": 1,
  "url": "https://example.com/hook",
  "name": "New hook name",
  "description": "Changed hook description",
  "group_id": 3,
  "push_events": true,
  "push_events_branch_filter": "",
  "branch_filter_strategy": "wildcard",
  "issues_events": true,
  "confidential_issues_events": true,
  "merge_requests_events": true,
  "tag_push_events": true,
  "note_events": true,
  "confidential_note_events": true,
  "job_events": true,
  "pipeline_events": true,
  "wiki_page_events": true,
  "deployment_events": true,
  "feature_flag_events": true,
  "releases_events": true,
  "milestone_events": true,
  "subgroup_events": true,
  "member_events": true,
  "project_events": true,
  "enable_ssl_verification": true,
  "repository_update_events": false,
  "alert_status": "executable",
  "disabled_until": null,
  "url_variables": [ ],
  "created_at": "2012-10-12T17:04:47Z",
  "resource_access_token_events": true,
  "custom_webhook_template": "{\"event\":\"{{object_kind}}\"}",
  "custom_headers": [
    {
      "key": "Authorization"
    }
  ],
  "token_present": false,
  "signing_token_present": false
}

グループフックを削除

指定されたグループフックを削除します。これは冪等なメソッドであり、複数回呼び出すことができます。フックが利用可能であるかどうか。

DELETE /groups/:id/hooks/:hook_id

サポートされている属性は以下のとおりです:

属性型必須説明
hook_id整数はいグループフックのID。
id整数または文字列はいグループのIDまたはURLエンコードされたパス。

リクエスト例:

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

成功した場合、メッセージは返されません。

テスト用のグループフックをトリガー

指定されたグループのテストフックをトリガーします。

このエンドポイントには、グループと認証済みユーザーごとに1分あたり5リクエストのレート制限があります。GitLab Self-ManagedおよびGitLab Dedicatedでこの制限を無効にするには、管理者がweb_hook_test_api_endpoint_rate_limitという名前の機能フラグを無効にできます。

POST /groups/:id/hooks/:hook_id/test/:trigger
属性型必須説明
hook_id整数はいグループフックのID。
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
trigger文字列はいpush_events、tag_push_events、issues_events、confidential_issues_events、note_events、merge_requests_events、job_events、pipeline_events、wiki_page_events、releases_events、milestone_events、emoji_events、またはresource_access_token_eventsのいずれか。

リクエスト例:

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

レスポンス例:

{"message":"201 Created"}

カスタムヘッダーを更新

指定されたグループフックのカスタムヘッダーを更新します。

PUT /groups/:id/hooks/:hook_id/custom_headers/:key

サポートされている属性は以下のとおりです:

属性型必須説明
hook_id整数はいグループフックのID。
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
key文字列はいカスタムヘッダーのキー。
value文字列はいカスタムヘッダーの値。

リクエスト例:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/3/hooks/1/custom_headers/header_key?value='header_value'"

成功した場合、メッセージは返されません。

カスタムヘッダーを削除

カスタムヘッダーを削除します。

DELETE /groups/:id/hooks/:hook_id/custom_headers/:key

サポートされている属性は以下のとおりです:

属性型必須説明
hook_id整数はいグループフックのID。
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
key文字列はいカスタムヘッダーのキー。

リクエスト例:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/3/hooks/1/custom_headers/header_key"

成功した場合、メッセージは返されません。

URL変数を更新

指定されたグループフックのURL変数を更新します。

PUT /groups/:id/hooks/:hook_id/url_variables/:key

サポートされている属性は以下のとおりです:

属性型必須説明
hook_id整数はいグループフックのID。
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
key文字列はいURL変数のキー。
value文字列はいURL変数の値。

リクエスト例:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/3/hooks/1/url_variables/my_key?value='my_key_value'"

成功した場合、メッセージは返されません。

URL変数を削除

指定されたグループフックのURL変数を削除します。

DELETE /groups/:id/hooks/:hook_id/url_variables/:key

サポートされている属性は以下のとおりです:

属性型必須説明
hook_id整数はいグループフックのID。
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
key文字列はいURL変数のキー。

リクエスト例:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/3/hooks/1/url_variables/my_key"

成功した場合、メッセージは返されません。