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

Harness Webhook API

The webhook API from Harness — 10 operation(s) for webhook.

Harness Webhook API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 16 operations across 10 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

16 operations 10 paths 13 schemas 2 DELETE8 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Webhook API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 16

Across 10 paths, the API surfaces 16 operations — 2 DELETE, 8 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Webhook 16
GET
/code/api/v1/repos/{repo_identifier}/webhooks
List repo webhooks
listRepoWebhooks 9 params → 200400401403500
POST
/code/api/v1/repos/{repo_identifier}/webhooks
Create repo webhook
createRepoWebhook 4 params body → 201400401403500
DELETE
/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}
Delete repo webhook
deleteRepoWebhook 5 params → 204400401403500
GET
/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}
Get repo webhook
getRepoWebhook 5 params → 200400401403500
PATCH
/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}
Update repo webhook
updateRepoWebhook 5 params body → 200400401403500
GET
/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions
List repo webhook executions
listRepoWebhookExecutions 7 params → 200400401403500
GET
/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}
Get repo webhook execution
getRepoWebhookExecution 8 params → 200400401403500
POST
/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger
Retrigger repo webhook execution
retriggerRepoWebhookExecution 6 params → 200400401403500
GET
/code/api/v1/webhooks
List acc, org or proj webhooks
listSpaceWebhooks 8 params → 200400401403500
POST
/code/api/v1/webhooks
Create acc, org or proj webhook
createSpaceWebhook 3 params body → 201400401403500
DELETE
/code/api/v1/webhooks/{webhook_identifier}
Delete acc, org or proj webhook
deleteSpaceWebhook 4 params → 204400401403500
GET
/code/api/v1/webhooks/{webhook_identifier}
Get acc, org or proj webhook
getSpaceWebhook 4 params → 200400401403500
PATCH
/code/api/v1/webhooks/{webhook_identifier}
Update acc, org or proj webhook
updateSpaceWebhook 4 params body → 200400401403500
GET
/code/api/v1/webhooks/{webhook_identifier}/executions
List acc, org or proj webhook executions
listSpaceWebhookExecutions 6 params → 200400401403500
GET
/code/api/v1/webhooks/{webhook_identifier}/executions/{webhook_execution_id}
Get acc, org or proj webhook execution
getSpaceWebhookExecution 7 params → 200400401403500
POST
/code/api/v1/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger
Retrigger acc, org or proj webhook execution
retriggerSpaceWebhookExecution 5 params → 200400401403500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are OpenapiWebhookType (18 properties), TypesWebhookExecution (11 properties), OpenapiCreateRepoWebhookRequest (10 properties), OpenapiUpdateSpaceWebhookRequest (10 properties). Each schema is shown below with its type and property counts.

TypesWebhookCreateInput
object
10 properties
OpenapiUpdateSpaceWebhookRequest
object
10 properties
TypesWebhookExecution
object
11 properties
OpenapiWebhookType
object
18 properties
EnumWebhookParent
string
OpenapiCreateRepoWebhookRequest
object
10 properties
EnumWebhookTrigger
string
EnumWebhookExecutionResult
stringnull
TypesWebhookExecutionResponse
object
4 properties
OpenapiUpdateRepoWebhookRequest
object
10 properties
TypesExtraHeader
object
3 properties
UsererrorError
object
2 properties
TypesWebhookExecutionRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-webhook-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Webhook 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.