We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
For the Issues Events API and Timeline API, learn about each event type, the triggering action on GitHub, and each event's unique properties.
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.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
added_to_project
The issue or pull request was added to a project board. You only see this event in responses when project boards have been enabled in the repository.
Availability
Issue type
Issue events API
Timeline events API
Issues
Pull request
X
X
Event object properties
Note: Project card details are now shown in REST API responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the blog post.
To receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
application/vnd.github.starfox-preview+json
Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact your site administrator.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
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".
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
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
This events properties do not use the same structure as the issue event object common properties. The following properties are returned for this event.
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
This events properties do not use the same structure as the issue event object common properties. The following properties are returned for this event.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
converted_note_to_issue
The issue was created by converting a note in a project board to an issue. You only see this event in responses when project boards have been enabled in the repository.
Availability
Issue type
Issue events API
Timeline events API
Issues
X
X
Event object properties
Note: Project card details are now shown in REST API responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the blog post.
To receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
application/vnd.github.starfox-preview+json
Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact your site administrator.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
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
This events properties do not use the same structure as the issue event object common properties. The following properties are returned for this event.
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.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
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.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
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. You only see this event in responses when project boards have been enabled in the repository.
Availability
Issue type
Issue events API
Timeline events API
Issues
Pull requests
X
X
Event object properties
Note: Project card details are now shown in REST API responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the blog post.
To receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
application/vnd.github.starfox-preview+json
Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact your site administrator.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
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.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
removed_from_project
The issue or pull request was removed from a project board. You only see this event in responses when project boards have been enabled in the repository.
Availability
Issue type
Issue events API
Timeline events API
Issues
Pull requests
X
X
Event object properties
Note: Project card details are now shown in REST API responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the blog post.
To receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
application/vnd.github.starfox-preview+json
Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact your site administrator.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
requested_reviewer
object
The person requested to review the pull request.
review_requester
object
The person who requested a review.
reviewed
The pull request was reviewed.
Availability
Issue type
Issue events API
Timeline events API
Pull requests
X
Event object properties
This events properties do not use the same structure as the issue event object common properties. The following properties are returned for this event.
Identifies the actual type of event that occurred.
commit_id
string
The SHA of the commit that referenced this issue.
commit_url
string
The GitHub REST API link to the commit that referenced this issue.
created_at
string
The timestamp indicating when the event occurred.
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.