Group webhooks API - Gitlabhq

Tier: Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Use this API to manage group webhooks. Group webhooks are different from system hooks that impact the entire instance, and project webhooks that are limited to a single project.

Prerequisites:

You must be an Administrator or have the Owner role for the group.

List all group hooks

Lists all group hooks for a specified group.

plaintext

GET /groups/:id/hooks

Supported attributes:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the group.

Example request:

shell

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

Example response:

json

[
  {
    "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"
      }
    ]
  }
]

Retrieve a group hook

Retrieves a specified group hook.

plaintext

GET /groups/:id/hooks/:hook_id

Supported attributes:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the group.
`hook_id`	integer	yes	The ID of a group hook.

Example request:

shell

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

Example response:

json

{
  "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"
    }
  ]
}

List all group hook events

Introduced in GitLab 17.3.

Lists all events for a specified group hook in the past seven days from the start date.

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`hook_id`	Integer	Yes	The ID of a project hook.
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.
`page`	Integer	No	Page to retrieve. Defaults to `1`.
`per_page`	Integer	No	Number of records to return per page. Defaults to `20`.
`status`	Integer or string	No	The response status code of the events, for example: `200` or `500`. You can search by status category: `successful` (200-299), `client_failure` (400-499), and `server_failure` (500-599).

Example request:

shell

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

Example response:

json

[
  {
    "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://[email protected]: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://[email protected]:2222/flightjs/Flight.git",
        "ssh_url": "ssh://[email protected]: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://[email protected]: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://[email protected]: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://[email protected]: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://[email protected]:2222/flightjs/Flight.git",
        "ssh_url": "ssh://[email protected]: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://[email protected]: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://[email protected]: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"
  }
]

Resend group hook event

Introduced in GitLab 17.4.

Resends a specific hook event.

This endpoint has a rate limit of five requests per minute for each hook and authenticated user. To disable this limit on GitLab Self-Managed and GitLab Dedicated, an administrator can disable the feature flag named web_hook_event_resend_api_endpoint_rate_limit.

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`hook_event_id`	Integer	Yes	The ID of a hook event.
`hook_id`	Integer	Yes	The ID of a group hook.
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.

Example request:

shell

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

Example response:

json

{
  "response_status": 200
}

Create a group hook

Creates a group hook for a specified group.

plaintext

POST /groups/:id/hooks

Supported attributes:

Attribute	Type	Required	Description
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.
`url`	String	Yes	The hook URL.
`branch_filter_strategy`	String	No	Filter push events by branch. Possible values are `wildcard` (default), `regex`, and `all_branches`.
`confidential_issues_events`	Boolean	No	Trigger hook on confidential issue events.
`confidential_note_events`	Boolean	No	Trigger hook on confidential note events.
`custom_headers`	Array	No	Custom headers for the hook.
`custom_webhook_template`	String	No	Custom webhook template for the hook.
`deployment_events`	Boolean	No	Trigger hook on deployment events.
`description`	String	No	Description of the hook (introduced in GitLab 17.1).
`enable_ssl_verification`	Boolean	No	Do SSL verification when triggering the hook.
`feature_flag_events`	Boolean	No	Trigger hook on feature flag events.
`issues_events`	Boolean	No	Trigger hook on issue events.
`job_events`	Boolean	No	Trigger hook on job events.
`member_events`	Boolean	No	Trigger hook on member events.
`merge_requests_events`	Boolean	No	Trigger hook on merge request events.
`milestone_events`	Boolean	No	Trigger hook on milestone events.
`name`	String	No	Name of the hook (introduced in GitLab 17.1).
`note_events`	Boolean	No	Trigger hook on note events.
`pipeline_events`	Boolean	No	Trigger hook on pipeline events.
`project_events`	Boolean	No	Trigger hook on project events.
`push_events`	Boolean	No	Trigger hook on push events.
`push_events_branch_filter`	String	No	Trigger hook on push events for matching branches only.
`releases_events`	Boolean	No	Trigger hook on release events.
`resource_access_token_events`	Boolean	No	Trigger hook on project access token expiry events.
`subgroup_events`	Boolean	No	Trigger hook on subgroup events.
`tag_push_events`	Boolean	No	Trigger hook on tag push events.
`token`	String	No	Secret token to validate received payloads; not returned in the response.
`wiki_page_events`	Boolean	No	Trigger hook on wiki page events.

Example request:

shell

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"}'

Example response:

json

{
  "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}}\"}",
}

Update a group hook

Updates a group hook for a specified group.

plaintext

PUT /groups/:id/hooks/:hook_id

Supported attributes:

Attribute	Type	Required	Description
`hook_id`	Integer	Yes	The ID of the group hook.
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.
`url`	String	Yes	The hook URL.
`branch_filter_strategy`	String	No	Filter push events by branch. Possible values are `wildcard` (default), `regex`, and `all_branches`.
`confidential_issues_events`	Boolean	No	Trigger hook on confidential issue events.
`confidential_note_events`	Boolean	No	Trigger hook on confidential note events.
`custom_headers`	Array	No	Custom headers for the hook.
`custom_webhook_template`	String	No	Custom webhook template for the hook.
`deployment_events`	Boolean	No	Trigger hook on deployment events.
`description`	String	No	Description of the hook (introduced in GitLab 17.1).
`enable_ssl_verification`	Boolean	No	Do SSL verification when triggering the hook.
`feature_flag_events`	Boolean	No	Trigger hook on feature flag events.
`issues_events`	Boolean	No	Trigger hook on issue events.
`job_events`	Boolean	No	Trigger hook on job events.
`member_events`	Boolean	No	Trigger hook on member events.
`merge_requests_events`	Boolean	No	Trigger hook on merge request events.
`milestone_events`	Boolean	No	Trigger hook on milestone events.
`name`	String	No	Name of the hook (introduced in GitLab 17.1).
`note_events`	Boolean	No	Trigger hook on note events.
`pipeline_events`	Boolean	No	Trigger hook on pipeline events.
`project_events`	Boolean	No	Trigger hook on project events.
`push_events`	Boolean	No	Trigger hook on push events.
`push_events_branch_filter`	String	No	Trigger hook on push events for matching branches only.
`releases_events`	Boolean	No	Trigger hook on release events.
`resource_access_token_events`	Boolean	No	Trigger hook on project access token expiry events.
`service_access_tokens_expiration_enforced`	Boolean	No	Require service account access tokens to have an expiration date.
`subgroup_events`	Boolean	No	Trigger hook on subgroup events.
`tag_push_events`	Boolean	No	Trigger hook on tag push events.
`token`	String	No	Secret token to validate received payloads. Not returned in the response. When you change the webhook URL, the secret token is reset and not retained.
`wiki_page_events`	Boolean	No	Trigger hook on wiki page events.

Example request:

shell

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"}'

Example response:

json

{
  "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"
    }
  ]
}

Delete a group hook

Deletes a specified group hook. This is an idempotent method and can be called multiple times. Either the hook is available or not.

plaintext

DELETE /groups/:id/hooks/:hook_id

Supported attributes:

Attribute	Type	Required	Description
`hook_id`	Integer	Yes	The ID of the group hook.
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.

Example request:

shell

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

On success, no message is returned.

Trigger a test group hook

Introduced in GitLab 17.1.
Special rate limit introduced in GitLab 17.1 with a flag named web_hook_test_api_endpoint_rate_limit. Enabled by default.

Trigger a test hook for a specified group.

This endpoint has a rate limit of five requests per minute for each group and authenticated user. To disable this limit on GitLab Self-Managed and GitLab Dedicated, an administrator can disable the feature flag named web_hook_test_api_endpoint_rate_limit.

plaintext

POST /groups/:id/hooks/:hook_id/test/:trigger

Attribute	Type	Required	Description
`hook_id`	Integer	Yes	The ID of the group hook.
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.
`trigger`	String	Yes	One of `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`, or `resource_access_token_events`.

Example request:

shell

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

Example response:

json

{"message":"201 Created"}

Update a custom header

Introduced in GitLab 17.1.

Updates a custom header for a specified group hook.

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`hook_id`	Integer	Yes	The ID of the group hook.
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.
`key`	String	Yes	The key of the custom header.
`value`	String	Yes	The value of the custom header.

Example request:

shell

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'"

On success, no message is returned.

Delete a custom header

Introduced in GitLab 17.1.

Deletes a custom header.

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`hook_id`	Integer	Yes	The ID of the group hook.
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.
`key`	String	Yes	The key of the custom header.

Example request:

shell

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

On success, no message is returned.

Update a URL variable

Introduced in GitLab 15.2.

Updates a URL variable for a specified group hook.

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`hook_id`	Integer	Yes	The ID of the group hook.
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.
`key`	String	Yes	The key of the URL variable.
`value`	String	Yes	The value of the URL variable.

Example request:

shell

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'"

On success, no message is returned.

Delete a URL variable

Deletes a URL variable for a specified group hook.

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`hook_id`	Integer	Yes	The ID of the group hook.
`id`	Integer or string	Yes	The ID or URL-encoded path of the group.
`key`	String	Yes	The key of the URL variable.

Example request:

shell

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

On success, no message is returned.