Harness

Webhook Triggers

This contains APIs related to Webhook Triggers.

Gets webhook event processing details for input eventId.

Securityx-api-key
Request
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 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets webhook event processing details for input eventId.
Securityx-api-key 
Request 
path Parameters
eventId
required
string
 
query Parameters
accountIdentifier
required
string
 
Responses 
400
Bad Request


500
Internal server error


default
Returns webhook event processing details for input eventId.


get/pipeline/api/webhook/triggerExecutionDetails/{eventId}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets webhook event processing details for input eventId when the trigger is queued and has not triggered the pipeline yet.
Securityx-api-key 
Request 
path Parameters
eventId
required
string
 
query Parameters
accountIdentifier
required
string
 
Responses 
400
Bad Request


500
Internal server error


default
Returns webhook event processing details for input eventId when the trigger is in queued state.


get/pipeline/api/webhook/triggerExecutionDetailsV2/{eventId}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Handles event payload for webhook triggers.
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
 
orgIdentifier
string
 
projectIdentifier
string
 
Request Body schema: 
required
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.
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
 
orgIdentifier
required
string
 
projectIdentifier
required
string
 
pipelineIdentifier
string
 
triggerIdentifier
string
 
Request Body schema: 
required
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": [
    ]
}
Handles event payload for custom webhook triggers.
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
orgIdentifier
required
string
Organization Identifier for the Entity.


 
projectIdentifier
required
string
Project Identifier for the Entity.


 
pipelineIdentifier
string
Pipeline Identifier


 
triggerIdentifier
string
Trigger Key


 
Request Body schema: 
required
Trigger Payload


string
 
Responses 
400
Bad Request


500
Internal server error


default
Returns data about of newly created custom webhook processing event.


post/pipeline/api/webhook/custom/v2
Request samples 
"string"
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Handles event payload for custom webhook triggers.
Securityx-api-key 
Request 
path Parameters
webhookToken
required
string
Custom Webhook token for custom webhook triggers


 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
orgIdentifier
required
string
Organization Identifier for the Entity.


 
projectIdentifier
required
string
Project Identifier for the Entity.


 
pipelineIdentifier
string
Pipeline Identifier


 
triggerIdentifier
string
Trigger Key


 
Request Body schema: 
required
Trigger Payload


string
 
Responses 
400
Bad Request


500
Internal server error


default
Returns data about of newly created custom webhook processing event.


post/pipeline/api/webhook/custom/{webhookToken}/v3
Request samples 
"string"
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to Webhook Event Handler