Webhook Triggers

This contains APIs related to Webhook Triggers.

Gets source repo types with all supported events.

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns source repo types with all supported events.

get/pipeline/api/webhook/sourceRepos
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/sourceRepos \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets trigger git actions for each supported event.

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns trigger git actions for each supported event.

get/pipeline/api/webhook/gitTriggerEventDetails
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/gitTriggerEventDetails \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets all supported scm webhook type.

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns all supported scm webhook type.

get/pipeline/api/webhook/webhookTriggerTypes
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/webhookTriggerTypes \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets all supported Github trigger events.

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns all supported Github trigger events.

get/pipeline/api/webhook/githubTriggerEvents
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/githubTriggerEvents \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets all supported Github PR event actions

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns all supported Github PR event actions.

get/pipeline/api/webhook/githubPRActions
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/githubPRActions \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets all supported Github Issue comment event actions

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns all supported Github Issue comment event actions.

get/pipeline/api/webhook/githubIssueCommentActions
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/githubIssueCommentActions \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets all supported Gitlab trigger events.

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns all supported Gitlab trigger events.

get/pipeline/api/webhook/gitlabTriggerEvents
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/gitlabTriggerEvents \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets all supported GitLab PR event actions.

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns all supported GitLab PR event actions.

get/pipeline/api/webhook/gitlabPRActions
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/gitlabPRActions \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets all supported Bitbucket trigger events.

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns all supported Bitbucket trigger events.

get/pipeline/api/webhook/bitbucketTriggerEvents
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/bitbucketTriggerEvents \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets all supported Bitbucket PR event actions.

Request
Security:
ApiKey (readwrite)
Responses
400

Bad Request

500

Internal server error

default

Returns all supported Bitbucket PR event actions.

get/pipeline/api/webhook/bitbucketPRActions
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/webhook/bitbucketPRActions \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get all supported actions for event type and source.

Request
Security:
ApiKey (readwrite)
query Parameters
sourceRepo
required
string
Enum: "GITHUB" "GITLAB" "BITBUCKET" "AWS_CODECOMMIT" "CUSTOM"
event
required
string
Responses
400

Bad Request

500

Internal server error

default

Returns all the supported actions for the specified event type and source.

get/pipeline/api/webhook/actions
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/webhook/actions?sourceRepo=GITHUB&event=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Handles event payload for webhook triggers.

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
Request Body schema:
string
Responses
400

Bad Request

500

Internal server error

default

Returns UUID of newly created webhook processing event.

post/pipeline/api/webhook/trigger
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Handles event payload for custom webhook triggers.

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
string
triggerIdentifier
string
Request Body schema:
string
Responses
400

Bad Request

500

Internal server error

default

Returns UUID of newly created custom webhook processing event.

post/pipeline/api/webhook/custom
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets webhook event processing details for input eventId.

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
eventId
required
string
Responses
400

Bad Request

500

Internal server error

default

Returns webhook event processing details for input eventId.

get/pipeline/api/webhook/triggerProcessingDetails
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/webhook/triggerProcessingDetails?accountIdentifier=string&eventId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}