GitLab Webhook Configuration API
Manage custom headers and URL variables for webhooks.
Operations 4
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
PUT
/projects/{id}/hooks/{hook_id}/custom_headers/{key}
Set a custom header on a webhook · GitLab Set a Webhook Custom Header
#
Ask an LLM
“How do I add an authorization header to every delivery from a project webhook?”
“Can I send a custom HTTP header with GitLab webhook requests?”
Tell an agent
Set header {key} to {value} on webhook {hook_id} of project {id}.
Add custom header {key}: {value} to hook {hook_id} in {id}.
DELETE
/projects/{id}/hooks/{hook_id}/custom_headers/{key}
Remove a custom header from a webhook · GitLab Delete a Webhook Custom Header
#
Ask an LLM
“How do I stop a webhook from sending one of its custom headers?”
“Can I delete a single custom header without recreating the hook?”
Tell an agent destructive · confirm first
Remove custom header {key} from webhook {hook_id} in project {id}.
Delete the {key} header on hook {hook_id} of {id}.
PUT
/projects/{id}/hooks/{hook_id}/url_variables/{key}
Set a URL variable on a webhook · GitLab Set a Webhook URL Variable
#
Ask an LLM
“How do I keep a secret out of a webhook URL by using a URL variable?”
“Can I substitute a placeholder in the webhook URL with a stored value?”
Tell an agent
Set URL variable {key} to {value} on webhook {hook_id} of project {id}.
Store {value} as the {key} URL placeholder for hook {hook_id} in {id}.
DELETE
/projects/{id}/hooks/{hook_id}/url_variables/{key}
Remove a URL variable from a webhook · GitLab Delete a Webhook URL Variable
#
Ask an LLM
“How do I delete a URL variable I no longer substitute into a webhook URL?”
“What happens to the webhook URL once I remove one of its URL variables?”
Tell an agent destructive · confirm first
Remove URL variable {key} from webhook {hook_id} in project {id}.
Delete the {key} URL placeholder value on hook {hook_id} of {id}.
Documentation
Documentation
https://docs.gitlab.com/api/groups/
Authentication
https://docs.gitlab.com/api/rest/authentication/
Documentation
https://docs.gitlab.com/api/projects/
Documentation
https://docs.gitlab.com/api/applications/
Documentation
https://docs.gitlab.com/api/avatar/
Documentation
https://docs.gitlab.com/api/broadcast_messages/
Documentation
https://docs.gitlab.com/api/bulk_imports/
Documentation
https://docs.gitlab.com/api/settings/
Documentation
https://docs.gitlab.com/api/metadata/
Documentation
https://docs.gitlab.com/api/version/
Documentation
https://docs.gitlab.com/api/rest/
APIReference
https://docs.gitlab.com/api/api_resources/
RateLimits
https://docs.gitlab.com/security/rate_limits/
Documentation
https://docs.gitlab.com/api/oauth2/
Authentication
https://docs.gitlab.com/integration/oauth_provider/
Documentation
https://docs.gitlab.com/user/project/integrations/webhooks.html
APIReference
https://docs.gitlab.com/api/project_webhooks/
Specifications
OpenAPI
https://artifacts.apis.io/gitlab/openapi/gitlab-webhook-configuration-api-openapi.yml
AsyncAPI
https://artifacts.apis.io/gitlab/asyncapi/gitlab-webhooks-asyncapi.yml