webhook

List webhooks

Securityx-api-key

Request

path Parameters

repo_identifier

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..
query	string The substring which is used to filter the webhooks by their identifier.
sort	string Default: "identifier" The data by which the webhooks are sorted. Enum: "id" "uid" "display_name" "created" "updated"
order	string Default: "asc" The order of the output. Enum: "asc" "desc"
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/webhooks

Request samples

curl
Java
Go

Response samples

application/json

[{"created": 0,
"created_by": 0,
"description": "string",
"display_name": "string",
"enabled": true,
"has_secret": true,
"id": 0,
"identifier": "string",
"insecure": true,
"latest_execution_result": "fatal_error",
"parent_id": 0,
"parent_type": "repo",
"triggers": ["branch_created"
],
"updated": 0,
"url": "string",
"version": 0
}
]

Create webhook

Securityx-api-key

Request

path Parameters

repo_identifier

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

description	string
display_name	string
enabled	boolean
identifier	string
insecure	boolean
secret	string
triggers	Array of strings or null (EnumWebhookTrigger) Enum: "branch_created" "branch_deleted" "branch_updated" "pullreq_branch_updated" "pullreq_closed" "pullreq_comment_created" "pullreq_created" "pullreq_merged" "pullreq_reopened" "tag_created" "tag_deleted" "tag_updated"
uid	string Deprecated
url	string

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/webhooks

Request samples

Payload
curl
Java
Go

application/json

{"description": "string",
"display_name": "string",
"enabled": true,
"identifier": "string",
"insecure": true,
"secret": "string",
"triggers": ["branch_created"
],
"uid": "string",
"url": "string"
}

Response samples

application/json

{"created": 0,
"created_by": 0,
"description": "string",
"display_name": "string",
"enabled": true,
"has_secret": true,
"id": 0,
"identifier": "string",
"insecure": true,
"latest_execution_result": "fatal_error",
"parent_id": 0,
"parent_type": "repo",
"triggers": ["branch_created"
],
"updated": 0,
"url": "string",
"version": 0
}

Delete webhook

Securityx-api-key

Request

path Parameters

repo_identifier required	string
webhook_identifier required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"message": "string",
"values": {"property1": null,
"property2": null
}
}

Get webhook

Securityx-api-key

Request

path Parameters

repo_identifier required	string
webhook_identifier required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"created": 0,
"created_by": 0,
"description": "string",
"display_name": "string",
"enabled": true,
"has_secret": true,
"id": 0,
"identifier": "string",
"insecure": true,
"latest_execution_result": "fatal_error",
"parent_id": 0,
"parent_type": "repo",
"triggers": ["branch_created"
],
"updated": 0,
"url": "string",
"version": 0
}

Update webhook

Securityx-api-key

Request

path Parameters

repo_identifier required	string
webhook_identifier required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

description	string or null
display_name	string or null
enabled	boolean or null
identifier	string or null
insecure	boolean or null
secret	string or null
triggers	Array of strings or null (EnumWebhookTrigger) Enum: "branch_created" "branch_deleted" "branch_updated" "pullreq_branch_updated" "pullreq_closed" "pullreq_comment_created" "pullreq_created" "pullreq_merged" "pullreq_reopened" "tag_created" "tag_deleted" "tag_updated"
uid	string or null Deprecated
url	string or null

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

patch/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}

Request samples

Payload
curl
Java
Go

application/json

{"description": "string",
"display_name": "string",
"enabled": true,
"identifier": "string",
"insecure": true,
"secret": "string",
"triggers": ["branch_created"
],
"uid": "string",
"url": "string"
}

Response samples

application/json

{"created": 0,
"created_by": 0,
"description": "string",
"display_name": "string",
"enabled": true,
"has_secret": true,
"id": 0,
"identifier": "string",
"insecure": true,
"latest_execution_result": "fatal_error",
"parent_id": 0,
"parent_type": "repo",
"triggers": ["branch_created"
],
"updated": 0,
"url": "string",
"version": 0
}

List webhook executions

Securityx-api-key

Request

path Parameters

repo_identifier required	string
webhook_identifier required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions

Request samples

curl
Java
Go

Response samples

application/json

[{"created": 0,
"duration": 0,
"error": "string",
"id": 0,
"request": {"body": "string",
"headers": "string",
"url": "string"
},
"response": {"body": "string",
"headers": "string",
"status": "string",
"status_code": 0
},
"result": "fatal_error",
"retrigger_of": 0,
"retriggerable": true,
"trigger_type": "branch_created",
"webhook_id": 0
}
]

Get webhook execution

Securityx-api-key

Request

path Parameters

repo_identifier required	string
webhook_identifier required	string
webhook_execution_id required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}

Request samples

curl
Java
Go

Response samples

application/json

{"created": 0,
"duration": 0,
"error": "string",
"id": 0,
"request": {"body": "string",
"headers": "string",
"url": "string"
},
"response": {"body": "string",
"headers": "string",
"status": "string",
"status_code": 0
},
"result": "fatal_error",
"retrigger_of": 0,
"retriggerable": true,
"trigger_type": "branch_created",
"webhook_id": 0
}

➔ Next to resource