Issue event types

Issue events are triggered by activity in issues and pull requests and are available in the Issue Events API and the Timeline Events API. Each event type specifies whether the event is available in the Issue Events or Timeline Events APIs.

GitHub's REST API considers every pull request to be an issue, but not every issue is a pull request. For this reason, the Issue Events and Timeline Events endpoints may return both issues and pull requests in the response. Pull requests have a pull_request property in the issue object. Because pull requests are issues, issue and pull request numbers do not overlap in a repository. For example, if you open your first issue in a repository, the number will be 1. If you then open a pull request, the number will be 2. Each event type specifies if the event occurs in pull request, issues, or both.

Issue event object common properties

Issue events all have the same object structure, except events that are only available in the Timeline Events API. Some events also include additional properties that provide more context about the event resources. Refer to the specific event to for details about any properties that differ from this object format.

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

added_to_project

The issue or pull request was added to a project board. 仅当在存储库中启用了项目板时，� 才会在响应中看到此事件。

Availability

Issue type	Issue events API	Timeline events API
Issues Pull request	X	X

Event object properties

注意：项目卡详细信息现在显示在项目相关议题和时间线事件的 REST API 响应中。此功能现在可供开发者预览。有关详细信息，请参阅此博客文� 。

若要接收 project_card 属性，则必须为存储库启用项目板，并且必须在 Accept � �头中提供自定义媒体类型：

application/vnd.github.starfox-preview+json

警告：在预览期间，API 可能会更改，恕不提前通知。预览功能不支持用于生产。如果遇到任何问题，请联系 � 的网站管理员。

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`project_card`	`object`	项目卡对象。
`project_id`	`integer`	项目卡的唯一� �识符。
`project_url`	`string`	用于检索项目卡的 REST API URL。
`column_name`	`string`	问题所在列的名称。

assigned

The issue or pull request was assigned to a user.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`assignee`	`object`	从此问题中取消分配的人员。
`assigner`	`object`	执行此问题的取消分配的人员。

automatic_base_change_failed

GitHub unsuccessfully attempted to automatically change the base branch of the pull request.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

automatic_base_change_succeeded

GitHub successfully attempted to automatically change the base branch of the pull request.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

base_ref_changed

The base reference branch of the pull request changed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

closed

The issue or pull request was closed. When the commit_id is present, it identifies the commit that closed the issue using "closes / fixes" syntax. For more information about the syntax, see "Linking a pull request to an issue".

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

commented

A comment was added to the issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests		X

Event object properties

此事件属性不使用与问题事件对象通用属性相同的结构。此事件返回以下属性。

Name	Type	Description
`url`	`string`	The REST API URL to retrieve the issue comment.
`html_url`	`string`	The HTML URL of the issue comment.
`issue_url`	`string`	The HTML URL of the issue.
`id`	`integer`	The unique identifier of the event.
`node_id`	`string`	The Global Node ID of the event.
`user`	`object`	The person who commented on the issue.
`created_at`	`string`	The timestamp indicating when the comment was added.
`updated_at`	`string`	The timestamp indicating when the comment was updated or created, if the comment is never updated.
`author_association`	`string`	The permissions the user has in the issue's repository. For example, the value would be `"OWNER"` if the owner of repository created a comment.
`body`	`string`	The comment body text.
`event`	`string`	The event value is `"commented"`.
`actor`	`object`	The person who generated the event.

committed

A commit was added to the pull request's HEAD branch.

Availability

Issue type	Issue events API	Timeline events API
Pull requests		X

Event object properties

此事件属性不使用与问题事件对象通用属性相同的结构。此事件返回以下属性。

Name	Type	Description
`sha`	`string`	The SHA of the commit in the pull request.
`node_id`	`string`	The Global Node ID of the event.
`url`	`string`	The REST API URL to retrieve the commit.
`html_url`	`string`	The HTML URL of the commit.
`author`	`object`	The person who authored the commit.
`committer`	`object`	The person who committed the commit on behalf of the author.
`tree`	`object`	The Git tree of the commit.
`message`	`string`	The commit message.
`parents`	`array of objects`	A list of parent commits.
`verification`	`object`	The result of verifying the commit's signature. For more information, see "Signature verification object."
`event`	`string`	The event value is `"committed"`.

connected

The issue or pull request was linked to another issue or pull request. For more information, see "Linking a pull request to an issue".

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

convert_to_draft

The pull request was converted to draft mode.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

converted_note_to_issue

The issue was created by converting a note in a project board to an issue. 仅当在存储库中启用了项目板时，� 才会在响应中看到此事件。

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

注意：项目卡详细信息现在显示在项目相关议题和时间线事件的 REST API 响应中。此功能现在可供开发者预览。有关详细信息，请参阅此博客文� 。

若要接收 project_card 属性，则必须为存储库启用项目板，并且必须在 Accept � �头中提供自定义媒体类型：

application/vnd.github.starfox-preview+json

警告：在预览期间，API 可能会更改，恕不提前通知。预览功能不支持用于生产。如果遇到任何问题，请联系 � 的网站管理员。

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`project_card`	`object`	项目卡对象。
`project_id`	`integer`	项目卡的唯一� �识符。
`project_url`	`string`	用于检索项目卡的 REST API URL。
`column_name`	`string`	问题所在列的名称。

converted_to_discussion

The issue was closed and converted to a discussion.

Availability

Issue type	Issue events API	Timeline events API
Issues	X

Event Object Properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

cross-referenced

The issue or pull request was referenced from another issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests		X

Event object properties

此事件属性不使用与问题事件对象通用属性相同的结构。此事件返回以下属性。

Name	Type	Description
`actor`	`object`	The person who generated the event.
`created_at`	`string`	The timestamp indicating when the cross-reference was added.
`updated_at`	`string`	The timestamp indicating when the cross-reference was updated or created, if the cross-reference is never updated.
`source`	`object`	The issue or pull request that added a cross-reference.
`source[type]`	`string`	This value will always be `"issue"` because pull requests are of type issue. Only cross-reference events triggered by issues or pull requests are returned in the Timeline Events API. To determine if the issue that triggered the event is a pull request, you can check if the `source[issue][pull_request]` object exists.
`source[issue]`	`object`	The `issue` object that added the cross-reference.
`event`	`string`	The event value is `"cross-referenced"`.

demilestoned

The issue or pull request was removed from a milestone.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`milestone`	`object`	The milestone object.
`milestone[title]`	`string`	The title of the milestone.

deployed

The pull request was deployed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

deployment_environment_changed

The pull request deployment environment was changed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

disconnected

The issue or pull request was unlinked from another issue or pull request. For more information, see "Linking a pull request to an issue".

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

head_ref_deleted

The pull request's HEAD branch was deleted.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

head_ref_restored

The pull request's HEAD branch was restored to the last known commit.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

head_ref_force_pushed

The pull request's HEAD branch was force pushed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

labeled

A label was added to the issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`label`	`object`	从问题 `label[name]`
`label[color]`	`string`	十六进制颜色代� �。

locked

The issue or pull request was locked.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`lock_reason`	`string`	The reason an issue or pull request conversation was locked, if one was provided.

mentioned

The actor was @mentioned in an issue or pull request body.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

marked_as_duplicate

A user with write permissions marked an issue as a duplicate of another issue, or a pull request as a duplicate of another pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

merged

The pull request was merged. The commit_id attribute is the SHA1 of the HEAD commit that was merged. The commit_repository is always the same as the main repository.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

milestoned

The issue or pull request was added to a milestone.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`milestone`	`object`	The milestone object.
`milestone[title]`	`string`	The title of the milestone.

moved_columns_in_project

The issue or pull request was moved between columns in a project board. 仅当在存储库中启用了项目板时，� 才会在响应中看到此事件。

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

注意：项目卡详细信息现在显示在项目相关议题和时间线事件的 REST API 响应中。此功能现在可供开发者预览。有关详细信息，请参阅此博客文� 。

若要接收 project_card 属性，则必须为存储库启用项目板，并且必须在 Accept � �头中提供自定义媒体类型：

application/vnd.github.starfox-preview+json

警告：在预览期间，API 可能会更改，恕不提前通知。预览功能不支持用于生产。如果遇到任何问题，请联系 � 的网站管理员。

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`project_card`	`object`	项目卡对象。
`project_id`	`integer`	项目卡的唯一� �识符。
`project_url`	`string`	用于检索项目卡的 REST API URL。
`column_name`	`string`	问题所在列的名称。
`previous_column_name`	`string`	The name of the column the issue was moved from.

pinned

The issue was pinned.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

ready_for_review

A draft pull request was marked as ready for review.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

referenced

The issue was referenced from a commit message. The commit_id attribute is the commit SHA1 of where that happened and the commit_repository is where that commit was pushed.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

removed_from_project

The issue or pull request was removed from a project board. 仅当在存储库中启用了项目板时，� 才会在响应中看到此事件。

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

注意：项目卡详细信息现在显示在项目相关议题和时间线事件的 REST API 响应中。此功能现在可供开发者预览。有关详细信息，请参阅此博客文� 。

若要接收 project_card 属性，则必须为存储库启用项目板，并且必须在 Accept � �头中提供自定义媒体类型：

application/vnd.github.starfox-preview+json

警告：在预览期间，API 可能会更改，恕不提前通知。预览功能不支持用于生产。如果遇到任何问题，请联系 � 的网站管理员。

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`project_card`	`object`	项目卡对象。
`project_id`	`integer`	项目卡的唯一� �识符。
`project_url`	`string`	用于检索项目卡的 REST API URL。
`column_name`	`string`	问题所在列的名称。

renamed

The issue or pull request title was changed.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`rename`	`object`	The name details.
`rename[from]`	`string`	The previous name.
`rename[to]`	`string`	The new name.

reopened

The issue or pull request was reopened.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

review_dismissed

The pull request review was dismissed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`dismissed_review`	`object`	被驳回审查的信息。
`dismissed_review[state]`	`string`	拉取请求被驳回时的状态。可以是以下选项之一：`commented`、`approved` 或 `changes_requested`。
`dismissed_review[review_id]`	`string`	拉取请求审查的唯一� �识符。
`dismissed_review[dismissal_message]`	`string`	驳回审查时用户包含的消息。
`dismissed_review[dismissal_commit_id]`	`string`	驳回审查的提交的唯一� �识符（如果存在）。

review_requested

A pull request review was requested.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`requested_reviewer`	`object`	被请求审查拉取请求的人员。
`review_requester`	`object`	请求审查的人员。

review_request_removed

A pull request review request was removed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`requested_reviewer`	`object`	被请求审查拉取请求的人员。
`review_requester`	`object`	请求审查的人员。

reviewed

The pull request was reviewed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests		X

Event object properties

此事件属性不使用与问题事件对象通用属性相同的结构。此事件返回以下属性。

Name	Type	Description
`id`	`integer`	The unique identifier of the event.
`node_id`	`string`	The Global Node ID of the event.
`user`	`object`	The person who commented on the issue.
`body`	`string`	The review summary text.
`commit_id`	`string`	The SHA of the latest commit in the pull request at the time of the review.
`submitted_at`	`string`	The timestamp indicating when the review was submitted.
`state`	`string`	The state of the submitted review. Can be one of: `commented`, `changes_requested`, or `approved`.
`html_url`	`string`	The HTML URL of the review.
`pull_request_url`	`string`	The REST API URL to retrieve the pull request.
`author_association`	`string`	The permissions the user has in the issue's repository. For example, the value would be `"OWNER"` if the owner of repository created a comment.
`_links`	`object`	The `html_url` and `pull_request_url`.
`event`	`string`	The event value is `"reviewed"`.

subscribed

Someone subscribed to receive notifications for an issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

transferred

The issue was transferred to another repository.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

unassigned

A user was unassigned from the issue.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`assignee`	`object`	从此问题中取消分配的人员。
`assigner`	`object`	执行此问题的取消分配的人员。

unlabeled

A label was removed from the issue.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`label`	`object`	从问题 `label[name]`
`label[color]`	`string`	十六进制颜色代� �。

unlocked

The issue was unlocked.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。
`lock_reason`	`string`	The reason an issue or pull request conversation was locked, if one was provided.

unmarked_as_duplicate

An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate, or a pull request that a user had previously marked as a duplicate of another pull request is no longer considered a duplicate.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

unpinned

The issue was unpinned.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

unsubscribed

Someone unsubscribed from receiving notifications for an issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests		X

Event object properties

名称	类型	说明
`id`	`integer`	事件的唯一� �识符。
`node_id`	`string`	事件的全局节点 ID。
`url`	`string`	用于提取事件的 REST API URL。
`actor`	`object`	生成事件的人。
`event`	`string`	识别所发生事件的实际类型。
`commit_id`	`string`	引用此议题的提交的 SHA。
`commit_url`	`string`	指向引用此议题的提交的 GitHub REST API 链接。
`created_at`	`string`	指示事件发生时间的时间戳。

Issue event types

本文内容

Issue event object common properties

added_to_project

Availability

Event object properties

assigned

Availability

Event object properties

automatic_base_change_failed

Availability

Event object properties

automatic_base_change_succeeded

Availability

Event object properties

base_ref_changed

Availability

Event object properties

closed

Availability

Event object properties

commented

Availability

Event object properties

committed

Availability

Event object properties

connected

Availability

Event object properties

convert_to_draft

Availability

Event object properties

converted_note_to_issue

Availability

Event object properties

converted_to_discussion

Availability

Event Object Properties

cross-referenced

Availability

Event object properties

demilestoned

Availability

Event object properties

deployed

Availability

Event object properties

deployment_environment_changed

Availability

Event object properties

disconnected

Availability

Event object properties

head_ref_deleted

Availability

Event object properties

head_ref_restored

Availability

head_ref_force_pushed

Availability

Event object properties

labeled

Availability

Event object properties

locked

Availability

Event object properties

mentioned

Availability

Event object properties

marked_as_duplicate

Availability

Event object properties

merged

Availability

Event object properties

milestoned

Availability

Event object properties