Harness

Org Gitx Webhooks

Lists all the GitX Webhooks at Org level

List org level GitX webhooks

Securityx-api-key
Request
path Parameters
org
required
string

Identifier field of the organization the resource is scoped to

query Parameters
page
integer
Default: 0

Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page

limit
integer <= 1000
Default: 20

Number of items to return per page.

webhook_identifier
string
header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses
200

Example response

get/v1/orgs/{org}/gitx-webhooks
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create Org Level GitX webhook
Create GitXWebhook at org level


Securityx-api-key 
Request 
path Parameters
org
required
string
Identifier field of the organization the resource is scoped to


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Request Body schema: application/json
Create GitX webhook request


webhook_identifier
string
 
repo_name
string
 
connector_ref
string
 
folder_paths
Array of strings
 
webhook_name
string
 
Responses 
200
Example response


post/v1/orgs/{org}/gitx-webhooks
Request samples 
application/json
{
  • "webhook_identifier": "<IDENTIFIER>",
  • "repo_name": "<REPO_NAME>",
  • "connector_ref": "<CONNECTOR_REF>",
  • "folder_paths": [
    ],
  • "webhook_name": "<NAME>"
}
Response samples 
application/json
{
  • "webhook_identifier": "<IDENTIFIER>"
}
Fetch GitX Webhook at org level
Fetch a org level gitx webhook


Securityx-api-key 
Request 
path Parameters
org
required
string
Identifier field of the organization the resource is scoped to


 
gitx-webhook
required
string
GitX webhook identifier


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
200
Example response


get/v1/orgs/{org}/gitx-webhooks/{gitx-webhook}
Request samples 
Response samples 
application/json
{
  • "webhook_identifier": "<IDENTIFIER>",
  • "webhook_name": "<NAME>",
  • "connector_ref": "<CONNECTOR_REF>",
  • "repo_name": "<REPO_NAME>",
  • "folder_paths": [
    ],
  • "is_enabled": true,
  • "event_trigger_time": 0
}
Updates a GitX Webhook at org level
Update a org level Gitx webhook


Securityx-api-key 
Request 
path Parameters
org
required
string
Identifier field of the organization the resource is scoped to


 
gitx-webhook
required
string
GitX webhook identifier


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Request Body schema: application/json
Update GitX webhook request


repo_name
string
 
webhook_name
string
 
folder_paths
Array of strings
 
is_enabled
boolean
 
connector_ref
string
 
Responses 
200
Example response


put/v1/orgs/{org}/gitx-webhooks/{gitx-webhook}
Request samples 
application/json
{
  • "repo_name": "<REPO_NAME>",
  • "connector_ref": "<CONNECTOR_REF>",
  • "webhook_name": "<NAME>",
  • "folder_paths": [
    ],
  • "is_enabled": true
}
Response samples 
application/json
{
  • "webhook_identifier": "<IDENTIFIER>"
}
Deletes a GitX Webhook at org level
Deletes a org level gitx webhooks


Securityx-api-key 
Request 
path Parameters
org
required
string
Identifier field of the organization the resource is scoped to


 
gitx-webhook
required
string
GitX webhook identifier


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
204
No Content


delete/v1/orgs/{org}/gitx-webhooks/{gitx-webhook}
Request samples 
➔ Next to Project Gitx Webhooks