跳到主要内容

Issue Event

Description of issue event parameters

Request Headers

Parameter NameTypeDescription
User-Agentstring
Content-Typestring
X-GitCode-EventstringEvent type, Issue Hook represents an issue event
X-GitCode-DeliverystringUnique request ID

Request Parameters

Parameter NameParameter TypeDescription
produce_random_idstringRandomly generated event ID
event_typestringEvent type, here is "issue"
object_kindstringObject type, here is "issue"
object_attributes.idintegerIssue ID
object_attributes.iidintegerIssue ID in the project
object_attributes.project_idintegerProject ID
object_attributes.titlestringIssue title
object_attributes.descriptionstringIssue description content
object_attributes.statestringIssue status (opened: open, closed: closed)
object_attributes.actionstringOperation type (open: open, close: close, reopen: re-open, update: update)
object_attributes.created_atstringCreation time
object_attributes.updated_atstringUpdate time
object_attributes.confidentialbooleanWhether it is a confidential issue
object_attributes.urlstringIssue's web access address
object_attributes.time_estimateinteger
object_attributes.total_time_spentinteger
object_attributes.human_time_estimateinteger
object_attributes.human_total_time_spentinteger
object_attributes.assignee_idsarrayAssignee ID list
object_attributes.author.idintegerAuthor ID
object_attributes.author.namestringAuthor name
object_attributes.author.usernamestringAuthor username
object_attributes.author.emailstringAuthor email
object_attributes.author.avatar_urlstringAuthor avatar URL
object_attributes.author.web_urlstringAuthor personal homepage URL
project.idintegerProject ID
project.namestringProject name
project.web_urlstringProject web access address
project.git_ssh_urlstringProject SSH clone address
project.git_http_urlstringProject HTTP clone address
project.namespacestringProject namespace
project.visibility_levelintegerProject visibility level (0: private, 1 public)
project.path_with_namespacestringProject path with namespace
project.default_branchstringDefault branch
user.idintegerUser ID triggering the event
user.namestringUser name triggering the event
user.usernamestringUsername triggering the event
user.emailstringUser email triggering the event
user.avatar_urlstringAvatar URL of the user triggering the event
labelsarrayIssue label list
changesobjectFields and new values of the changed Issue
manual_buildbooleanWhether it is manually triggered
uuidstringUnique identifier for the event

Request Parameters Example

{
"produce_random_id": "9f2bcb9c4c8a41d8bc89e8dc61bbf3ac",
"event_type": "issue",
"object_attributes": {
"iid": 8,
"created_at": "2025-05-07T14:19:24.490+08:00",
"description": "content",
"title": "Test Issue",
"updated_at": "2025-05-07T14:19:24.490+08:00",
"project_id": 1848674,
"action": "open",
"id": 3084068,
"state": "opened",
"confidential": false,
"relative_position": 1073745823,
"author": {
"id": 173794,
"name": "xiaogang_o",
"username": "xiaogang_o",
"iam_id": "ec7b9ce722694cce89d8186a8ec5645f",
"nick_name": "Xiao Gang",
"state": "active",
"avatar_url": "https://cdn-img.gitcode.com/ee/ca/756863eec250a6a067148d4d4fe71d28c3b9716a6f79c03a9f460543fa3dc838.jpg?time=1711433667506",
"email": "xiaogang@csdn.net",
"web_url": "https://gitcode.com/xiaogang_o"
},
"url": "https://gitcode.com/xiaogang_o/test/issues/8",
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": 0,
"human_total_time_spent": 0,
"assignee_ids": []
},
"project": {
"path_with_namespace": "xiaogang_o/test",
"ssh_url": "git@gitcode.com:xiaogang_o/test.git",
"git_http_url": "https://gitcode.com/xiaogang_o/test.git",
"git_ssh_url": "git@gitcode.com:xiaogang_o/test.git",
"url": "git@gitcode.com:xiaogang_o/test.git",
"http_url": "https://gitcode.com/xiaogang_o/test.git",
"web_url": "https://gitcode.com/xiaogang_o/test",
"avatar_url": "https://cdn-img.gitcode.com/ee/ca/756863eec250a6a067148d4d4fe71d28c3b9716a6f79c03a9f460543fa3dc838.jpg?time=1711433667506",
"name": "test",
"namespace": "xiaogang_o",
"visibility_level": 0,
"default_branch": "main",
"id": 1848674,
"homepage": "https://gitcode.com/xiaogang_o/test"
},
"user": {
"avatar_url": "https://cdn-img.gitcode.com/ee/ca/756863eec250a6a067148d4d4fe71d28c3b9716a6f79c03a9f460543fa3dc838.jpg?time=1711433667506",
"name": "xiaogang_o",
"id": 173794,
"email": "xiaogang@csdn.net",
"username": "xiaogang_o"
},
"manual_build": false,
"object_kind": "issue",
"labels": [],
"uuid": "e4e3a55e-4f58-42dd-a134-c128259809f2"
}