Harness

Webhooks

APIs to create, update, list webhooks

ListWebhooks

Returns List of Webhook Details

Securityx-api-key
Request
path Parameters
registry_ref
required
string

Reference to the scope in which the registry exists.

Format depends on the scope:

  • Account-level: account_id/registry_name/+
  • Organization-level: account_id/org_id/registry_name/+
  • Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Examples:
Only account ID, scoped at account level
acc123/registry123/+
Account and org ID, scoped at org level
acc123/org456/registry123/+
Account, org, and project ID, scoped at project level
acc123/org456/proj789/registry123/+
query Parameters
page
integer <int64>
Default: 1

Current page number

size
integer <int64>
Default: 20

Number of items per page

sort_order
string

sortOrder

sort_field
string

sortField

search_term
string

search Term.

Responses
200

response for list webhooks

400

Bad request

401

Unauthenticated

403

Unauthorized

500

Internal server error

get/har/api/v1/registry/{registry_ref}/webhooks
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "status": "SUCCESS"
}
CreateWebhook
Returns Webhook Details


Securityx-api-key 
Request 
path Parameters
registry_ref
required
string
Reference to the scope in which the registry exists.


Format depends on the scope:


    

  • Account-level: account_id/registry_name/+
    • 

  • Organization-level: account_id/org_id/registry_name/+
    • 

  • Project-level: account_id/org_id/project_id/registry_name/+
    • 



The /+ suffix is used internally to route scoped requests.
It must be included exactly as shown in the URL.


  Examples: 
Only account ID, scoped at account level 
acc123/registry123/+
Account and org ID, scoped at org level 
acc123/org456/registry123/+
Account, org, and project ID, scoped at project level 
acc123/org456/proj789/registry123/+
Request Body schema: application/json
request for create and update webhook


description
string
 
enabled
required
boolean
 
Array of objects (ExtraHeader) 
 
identifier
required
string
 
insecure
required
boolean
 
name
required
string
 
secretIdentifier
string
 
secretSpaceId
integer <int64> 
 
secretSpacePath
string
 
triggers
Array of strings (Trigger) 
Items Enum: "ARTIFACT_CREATION" "ARTIFACT_DELETION"  
url
required
string
 
Responses 
201
response for create, get and update webhook


400
Bad request


401
Unauthenticated


403
Unauthorized


500
Internal server error


post/har/api/v1/registry/{registry_ref}/webhooks
Request samples 
application/json
{
  • "description": "string",
  • "enabled": true,
  • "extraHeaders": [
    ],
  • "identifier": "string",
  • "insecure": true,
  • "name": "string",
  • "secretIdentifier": "string",
  • "secretSpaceId": 0,
  • "secretSpacePath": "string",
  • "triggers": [
    ],
  • "url": "string"
}
Response samples 
application/json
{
  • "data": {
    },
  • "status": "SUCCESS"
}
DeleteWebhook
Delete a Webhook


Securityx-api-key 
Request 
path Parameters
registry_ref
required
string
Reference to the scope in which the registry exists.


Format depends on the scope:


    

  • Account-level: account_id/registry_name/+
    • 

  • Organization-level: account_id/org_id/registry_name/+
    • 

  • Project-level: account_id/org_id/project_id/registry_name/+
    • 



The /+ suffix is used internally to route scoped requests.
It must be included exactly as shown in the URL.


  Examples: 
Only account ID, scoped at account level 
acc123/registry123/+
Account and org ID, scoped at org level 
acc123/org456/registry123/+
Account, org, and project ID, scoped at project level 
acc123/org456/proj789/registry123/+
webhook_identifier
required
string
Unique webhook identifier.


 
Responses 
200
Success Response


400
Bad request


401
Unauthenticated


403
Unauthorized


404
The specified resource was not found


500
Internal server error


delete/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}
Request samples 
Response samples 
application/json
{
  • "status": "SUCCESS"
}
GetWebhook
Returns Webhook Details


Securityx-api-key 
Request 
path Parameters
registry_ref
required
string
Reference to the scope in which the registry exists.


Format depends on the scope:


    

  • Account-level: account_id/registry_name/+
    • 

  • Organization-level: account_id/org_id/registry_name/+
    • 

  • Project-level: account_id/org_id/project_id/registry_name/+
    • 



The /+ suffix is used internally to route scoped requests.
It must be included exactly as shown in the URL.


  Examples: 
Only account ID, scoped at account level 
acc123/registry123/+
Account and org ID, scoped at org level 
acc123/org456/registry123/+
Account, org, and project ID, scoped at project level 
acc123/org456/proj789/registry123/+
webhook_identifier
required
string
Unique webhook identifier.


 
Responses 
200
response for create, get and update webhook


400
Bad request


401
Unauthenticated


403
Unauthorized


500
Internal server error


get/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "status": "SUCCESS"
}
UpdateWebhook
Returns Webhook Details


Securityx-api-key 
Request 
path Parameters
registry_ref
required
string
Reference to the scope in which the registry exists.


Format depends on the scope:


    

  • Account-level: account_id/registry_name/+
    • 

  • Organization-level: account_id/org_id/registry_name/+
    • 

  • Project-level: account_id/org_id/project_id/registry_name/+
    • 



The /+ suffix is used internally to route scoped requests.
It must be included exactly as shown in the URL.


  Examples: 
Only account ID, scoped at account level 
acc123/registry123/+
Account and org ID, scoped at org level 
acc123/org456/registry123/+
Account, org, and project ID, scoped at project level 
acc123/org456/proj789/registry123/+
webhook_identifier
required
string
Unique webhook identifier.


 
Request Body schema: application/json
request for create and update webhook


description
string
 
enabled
required
boolean
 
Array of objects (ExtraHeader) 
 
identifier
required
string
 
insecure
required
boolean
 
name
required
string
 
secretIdentifier
string
 
secretSpaceId
integer <int64> 
 
secretSpacePath
string
 
triggers
Array of strings (Trigger) 
Items Enum: "ARTIFACT_CREATION" "ARTIFACT_DELETION"  
url
required
string
 
Responses 
201
response for create, get and update webhook


400
Bad request


401
Unauthenticated


403
Unauthorized


500
Internal server error


put/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}
Request samples 
application/json
{
  • "description": "string",
  • "enabled": true,
  • "extraHeaders": [
    ],
  • "identifier": "string",
  • "insecure": true,
  • "name": "string",
  • "secretIdentifier": "string",
  • "secretSpaceId": 0,
  • "secretSpacePath": "string",
  • "triggers": [
    ],
  • "url": "string"
}
Response samples 
application/json
{
  • "data": {
    },
  • "status": "SUCCESS"
}
ListWebhookExecutions
Returns Webhook Execution Details List


Securityx-api-key 
Request 
path Parameters
registry_ref
required
string
Reference to the scope in which the registry exists.


Format depends on the scope:


    

  • Account-level: account_id/registry_name/+
    • 

  • Organization-level: account_id/org_id/registry_name/+
    • 

  • Project-level: account_id/org_id/project_id/registry_name/+
    • 



The /+ suffix is used internally to route scoped requests.
It must be included exactly as shown in the URL.


  Examples: 
Only account ID, scoped at account level 
acc123/registry123/+
Account and org ID, scoped at org level 
acc123/org456/registry123/+
Account, org, and project ID, scoped at project level 
acc123/org456/proj789/registry123/+
webhook_identifier
required
string
Unique webhook identifier.


 
query Parameters
page
integer <int64> 
 Default:  1
Current page number


 
size
integer <int64> 
 Default:  20
Number of items per page


 
Responses 
200
list webhooks executions response


400
Bad request


401
Unauthenticated


403
Unauthorized


500
Internal server error


get/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "status": "SUCCESS"
}
GetWebhookExecution
Returns Webhook Execution Details


Securityx-api-key 
Request 
path Parameters
registry_ref
required
string
Reference to the scope in which the registry exists.


Format depends on the scope:


    

  • Account-level: account_id/registry_name/+
    • 

  • Organization-level: account_id/org_id/registry_name/+
    • 

  • Project-level: account_id/org_id/project_id/registry_name/+
    • 



The /+ suffix is used internally to route scoped requests.
It must be included exactly as shown in the URL.


  Examples: 
Only account ID, scoped at account level 
acc123/registry123/+
Account and org ID, scoped at org level 
acc123/org456/registry123/+
Account, org, and project ID, scoped at project level 
acc123/org456/proj789/registry123/+
webhook_identifier
required
string
Unique webhook identifier.


 
webhook_execution_id
required
string
Unique webhook execution identifier.


 
Responses 
200
webhook execution response


400
Bad request


401
Unauthenticated


403
Unauthorized


500
Internal server error


get/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "status": "SUCCESS"
}
ReTriggerWebhookExecution
Retrigger Webhook Execution


Securityx-api-key 
Request 
path Parameters
registry_ref
required
string
Reference to the scope in which the registry exists.


Format depends on the scope:


    

  • Account-level: account_id/registry_name/+
    • 

  • Organization-level: account_id/org_id/registry_name/+
    • 

  • Project-level: account_id/org_id/project_id/registry_name/+
    • 



The /+ suffix is used internally to route scoped requests.
It must be included exactly as shown in the URL.


  Examples: 
Only account ID, scoped at account level 
acc123/registry123/+
Account and org ID, scoped at org level 
acc123/org456/registry123/+
Account, org, and project ID, scoped at project level 
acc123/org456/proj789/registry123/+
webhook_identifier
required
string
Unique webhook identifier.


 
webhook_execution_id
required
string
Unique webhook execution identifier.


 
Responses 
200
webhook execution response


400
Bad request


401
Unauthenticated


403
Unauthorized


500
Internal server error


get/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "status": "SUCCESS"
}
➔ Next to Replication