Webhooks

Webhook API Documentation

1. List WebHooks of a Repository

Request

GET https://api.gitcode.com/api/v5/repos/{owner}/{repo}/hooks

Parameters

Parameter	Description	Type	Data Type
access_token	personal access token	query	string
owner*	Repository Ownership Path (Company, Organization, or Personal Path)	path	string
repo*	Repository Path(path)	path	string
page	Current Page Number	query	int
per_page	Items Per Page, Maximum 100,default:20	query	int

Response

[
  {
    "id": 9523,
    "url": "http://duxwsqdkyx.cu/pxssss",
    "password": "123445",
    "result": "not found",
    "project_id": 282463,
    "result_code": 503,
    "push_events": false,
    "tag_push_events": false,
    "issues_events": true,
    "note_events": false,
    "merge_requests_events": true,
    "created_at": "2024-09-18T17:51:44+08:00"
  }
]

Demo

curl --location --request GET 'https://api.gitcode.com/api/v5/repos/mactribe/test02/hooks?access_token={your-token}'

2. Create a WebHook for a Repository

Request

POST https://api.gitcode.com/api/v5/repos/{owner}/{repo}/hooks

Parameters

Parameter	Description	Type	Data Type
access_token	personal access token	formData	string
owner*	Repository Ownership Path (Company, Organization, or Personal Path)	path	string
repo*	Repository Path(path)	path	string
url*	url	formData	string
encryption_type	Encryption Type: 0(Password), 1(Signature Key)	formData	int
password	The password is included in the request URL to prevent malicious requests.	formData	string
push_events	Push Code to Repository Event	formData	boolean
tag_push_events	Tag Push to Repository Event	formData	boolean
issues_events	Issue Creation/Closure Event	formData	boolean
note_events	Comment on Issue/PR/commit Event	formData	boolean
merge_requests_events	Merge Request Creation and Merging Event	formData	boolean

Response

{
  "id": 9529,
  "url": "http://duxwsqdkyx.cu/pxddddd",
  "password": "123445",
  "result": null,
  "project_id": 282463,
  "result_code": 0,
  "push_events": false,
  "tag_push_events": false,
  "issues_events": true,
  "note_events": false,
  "merge_requests_events": true,
  "created_at": "2024-09-26T16:13:27+08:00"
}

Demo

curl --location --request POST 'https://api.gitcode.com/api/v5/repos/mactribe/test02/hooks?access_token={your-token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://duxwsqdkyx.cu/px",
    "encryption_type": 0,
    "password": "123445",
    "push_events": false,
    "tag_push_events": false,
    "issues_events": true,
    "note_events": false,
    "merge_requests_events": true
}'

3. Get a Specific WebHook of a Repository

Request

GET https://api.gitcode.com/api/v5/repos/{owner}/{repo}/hooks/{id}

Parameters

Parameter	Description	Type	Data Type
access_token	personal access token	query	string
owner*	Repository Ownership Path (Company, Organization, or Personal Path)	path	string
repo*	Repository Path(path)	path	string
id*	ID of Webhook	path	string

Response

{
  "id": 9529,
  "url": "http://duxwsqdkyx.cu/pxddddd",
  "password": "123445",
  "result": null,
  "project_id": 282463,
  "result_code": 0,
  "push_events": false,
  "tag_push_events": false,
  "issues_events": true,
  "note_events": false,
  "merge_requests_events": true,
  "created_at": "2024-09-26T16:13:27+08:00"
}

Demo

curl --location --request GET 'https://api.gitcode.com/api/v5/repos/mactribe/test02/hooks/9524?access_token={your-token}'

4. Update a WebHook of a Repository

Request

PATCH https://api.gitcode.com/api/v5/repos/{owner}/{repo}/hooks/{id}

Parameters

Parameter	Description	Type	Data Type
access_token	personal access token	query	string
owner*	Repository Ownership Path (Company, Organization, or Personal Path)	path	string
repo*	Repository Path(path)	path	string
id*	ID of Webhook	path	string
url*	url	formData	string
encryption_type	Encryption Type: 0(Password), 1(Signature Key)	formData	int
password	The password is included in the request URL to prevent malicious requests.	formData	string
push_events	Push Code to Repository Event	formData	boolean
tag_push_events	Tag Push to Repository Event	formData	boolean
issues_events	Issue Creation/Closure Event	formData	boolean
note_events	Comment on Issue/PR/commit Event	formData	boolean
merge_requests_events	Merge Request Creation and Merging Event	formData	boolean

Response

{
  "url": "http://duxwsqdkyx.cu/pxddddd",
  "password": "123445",
  "result": null,
  "project_id": 282463,
  "result_code": 0,
  "push_events": false,
  "tag_push_events": false,
  "issues_events": true,
  "note_events": false,
  "merge_requests_events": true,
  "created_at": "2024-09-26T16:13:27+08:00"
}

Demo

curl --location --request PATCH 'https://api.gitcode.com/api/v5/repos/mactribe/test02/hooks/9516?access_token={your-token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://duxwsqdkyx.cu/dengmm",
    "encryption_type": 0,
    "password": "334455",
    "push_events": true,
    "tag_push_events": true,
    "issues_events": false,
    "note_events": true,
    "merge_requests_events": true
}'

5. Delete a WebHook of a Repository

Request

DELETE https://api.gitcode.com/api/v5/repos/{owner}/{repo}/hooks/{id}

Parameters

Parameter	Description	Type	Data Type
access_token	personal access token	query	string
owner*	Repository Ownership Path (Company, Organization, or Personal Path)	path	string
repo*	Repository Path(path)	path	string
id*	ID of Webhook	path	string

Response

Http Code: 204, No Content

Demo

curl --location --request DELETE 'https://api.gitcode.com/api/v5/repos/mactribe/test02/hooks/9516?access_token={your-token}'

6. Test if a WebHook is Successfully Sent

Request

POST https://api.gitcode.com/api/v5/repos/{owner}/{repo}/hooks/{id}/tests

Parameters

Parameter	Description	Type	Data Type
access_token	personal access token	query	string
owner*	Repository Ownership Path (Company, Organization, or Personal Path)	path	string
repo*	Repository Path(path)	path	string
id*	ID of Webhook	path	string

Response

Http Code: 204, No Content

Demo

curl --location --request POST 'https://api.gitcode.com/api/v5/repos/mactribe/test02/hooks/9516/tests?access_token={your-token}'

← Milestone API Documentation

Member API Documentation →