How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GitLab CI/CD

GitLab CI/CD hooks API

Operations about hooks

Documentation Provider Profile APIs.io OpenAPI GitHub

GitLab CI/CD hooks API is one of 98 APIs that GitLab CI/CD publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Hooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 22 operations across 11 paths, and defines 10 schemas. It is described by OpenAPI 2.0, at version v4.

Requests are made against the base URL https://gitlab.com/api/v4.

22 operations 11 paths 10 schemas 6 DELETE5 GET5 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v4
Base URL
https://gitlab.com/api/v4
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

GitLab CI/CD hooks API declares 2 security schemes for authenticating requests. An API key is passed in the header as PRIVATE-TOKEN (access_token_header). An API key is passed in the query as private_token (access_token_query).

Paths & Operations 22

Across 11 paths, the API surfaces 22 operations — 6 DELETE, 5 GET, 5 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

hooks 22

Operations about hooks

PUT
/api/v4/projects/{id}/hooks/{hook_id}/url_variables/{key}
Set a url variable
putApiV4ProjectsIdHooksHookIdUrlVariablesKey 4 params → 200
DELETE
/api/v4/projects/{id}/hooks/{hook_id}/url_variables/{key}
Un-Set a url variable
deleteApiV4ProjectsIdHooksHookIdUrlVariablesKey 3 params → 204
PUT
/api/v4/projects/{id}/hooks/{hook_id}/custom_headers/{key}
Set a custom header
putApiV4ProjectsIdHooksHookIdCustomHeadersKey 4 params → 200
DELETE
/api/v4/projects/{id}/hooks/{hook_id}/custom_headers/{key}
Un-Set a custom header
deleteApiV4ProjectsIdHooksHookIdCustomHeadersKey 3 params → 204
GET
/api/v4/projects/{id}/hooks
List project hooks
getApiV4ProjectsIdHooks 3 params → 200
POST
/api/v4/projects/{id}/hooks
Add project hook
postApiV4ProjectsIdHooks 2 params → 201400404422
GET
/api/v4/projects/{id}/hooks/{hook_id}
Get project hook
getApiV4ProjectsIdHooksHookId 2 params → 200404
PUT
/api/v4/projects/{id}/hooks/{hook_id}
Edit project hook
putApiV4ProjectsIdHooksHookId 3 params → 200400404422
DELETE
/api/v4/projects/{id}/hooks/{hook_id}
Delete a project hook
deleteApiV4ProjectsIdHooksHookId 2 params → 204
GET
/api/v4/projects/{id}/hooks/{hook_id}/events
Get events for a given hook id
getApiV4ProjectsIdHooksHookIdEvents 5 params → 200400404403
POST
/api/v4/projects/{id}/hooks/{hook_id}/test/{trigger}
Triggers a hook test
postApiV4ProjectsIdHooksHookIdTestTrigger 3 params → 201400404422429
POST
/api/v4/projects/{id}/hooks/{hook_id}/events/{hook_log_id}/resend
Resend a webhook event
postApiV4ProjectsIdHooksHookIdEventsHookLogIdResend 3 params → 201422404429
PUT
/api/v4/hooks/{hook_id}/url_variables/{key}
Set a url variable
putApiV4HooksHookIdUrlVariablesKey 3 params → 200
DELETE
/api/v4/hooks/{hook_id}/url_variables/{key}
Un-Set a url variable
deleteApiV4HooksHookIdUrlVariablesKey 2 params → 204
PUT
/api/v4/hooks/{hook_id}/custom_headers/{key}
Set a custom header
putApiV4HooksHookIdCustomHeadersKey 3 params → 200
DELETE
/api/v4/hooks/{hook_id}/custom_headers/{key}
Un-Set a custom header
deleteApiV4HooksHookIdCustomHeadersKey 2 params → 204
GET
/api/v4/hooks
List system hooks
getApiV4Hooks 2 params → 200
POST
/api/v4/hooks
Add new system hook
postApiV4Hooks 1 param → 201400404422
GET
/api/v4/hooks/{hook_id}
Get system hook
getApiV4HooksHookId 1 param → 200404
PUT
/api/v4/hooks/{hook_id}
Edit system hook
putApiV4HooksHookId 2 params → 200400404422
POST
/api/v4/hooks/{hook_id}
Test a hook
postApiV4HooksHookId 1 param → 201
DELETE
/api/v4/hooks/{hook_id}
Delete system hook
deleteApiV4HooksHookId 1 param → 404204

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are API_Entities_ProjectHook (36 properties), postApiV4ProjectsIdHooks (29 properties), putApiV4ProjectsIdHooksHookId (29 properties), API_Entities_Hook (20 properties). Each schema is shown below with its type and property counts.

API_Entities_Hook
object
APIEntitiesHook model
20 properties 17 required
postApiV4ProjectsIdHooks
object
Add project hook
29 properties 1 required
postApiV4Hooks
object
Add new system hook
15 properties 1 required
putApiV4HooksHookIdUrlVariablesKey
object
Set a url variable
1 property 1 required
putApiV4ProjectsIdHooksHookId
object
Edit project hook
29 properties
putApiV4HooksHookId
object
Edit system hook
15 properties
putApiV4HooksHookIdCustomHeadersKey
object
Set a custom header
1 property 1 required
putApiV4ProjectsIdHooksHookIdUrlVariablesKey
object
Set a url variable
1 property 1 required
API_Entities_ProjectHook
object
APIEntitiesProjectHook model
36 properties 33 required
putApiV4ProjectsIdHooksHookIdCustomHeadersKey
object
Set a custom header
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-hooks-api-openapi.yml Raw ↑

Other APIs GitLab CI/CD publishes across the network.

GitLab GraphQL API
AE Profile APIs.io
GitLab CI/CD access_requests API
AE Profile APIs.io
GitLab CI/CD access_tokens API
AE Profile APIs.io
GitLab CI/CD agents API
AE Profile APIs.io
GitLab CI/CD alert_management API
AE Profile APIs.io
GitLab CI/CD applications API
AE Profile APIs.io
GitLab CI/CD attestations API
AE Profile APIs.io
GitLab CI/CD audit_events API
AE Profile APIs.io
GitLab CI/CD avatars API
AE Profile APIs.io
GitLab CI/CD award_emoji API
AE Profile APIs.io
GitLab CI/CD badges API
AE Profile APIs.io
GitLab CI/CD batched_background_migrations API
AE Profile APIs.io
#Hooks
← Back to G APIs
API Details
ID
gitlab-ci:gitlab-ci-hooks-api
Base URL
https://gitlab.com/api/v4
Docs
https://docs.gitlab.com/api/
Provider
GitLab CI/CD
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gitlab-ci-hooks-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gitlab-ci-hooks-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of GitLab CI/CD hooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.