For the REST APIs for issue events and timeline events, 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 REST API for Issue events and Timeline events. Each event type specifies whether the event is available in the REST API for issue events or timeline events.
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 events all have the same object structure, except events that are only available in the REST API for timeline events. Some events also include additional properties that provide more context about the event resources. Refer to the specific event for details about any properties that differ from this object format.
Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. assigned
The issue or pull request was assigned to a user.
This event is available for the following issue types.
Properties for assigned Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. assignee object The person assigned to this issue. assigner object The person who performed the assignment for this issue. This field is available in the REST API for issue events but not the REST API for timeline events. automatic_base_change_failed
GitHub unsuccessfully attempted to automatically change the base branch of the pull request.
This event is available for the following issue types.
Properties for automatic_base_change_failed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. automatic_base_change_succeeded
GitHub successfully attempted to automatically change the base branch of the pull request.
This event is available for the following issue types.
Properties for automatic_base_change_succeeded Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. base_ref_changed
The base reference branch of the pull request changed.
This event is available for the following issue types.
Properties for base_ref_changed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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.
This event is available for the following issue types.
Properties for closed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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.
A comment was added to the issue or pull request.
This event is available for the following issue types.
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 Descriptionurl 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.
This event is available for the following issue types.
Properties for committedThis 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 Descriptionsha 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 REST API endpoints for Git commits. 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.
This event is available for the following issue types.
Properties for connected Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. convert_to_draft
The pull request was converted to draft mode.
This event is available for the following issue types.
Properties for convert_to_draft Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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_to_discussion
The issue was closed and converted to a discussion.
This event is available for the following issue types.
Properties for converted_to_discussion Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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.
This event is available for the following issue types.
Properties for cross-referencedThis 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 Descriptionactor 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 REST API for timeline events. 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.
This event is available for the following issue types.
Properties for demilestoned Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. deployed
The pull request was deployed.
This event is available for the following issue types.
Properties for deployed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. deployment_environment_changed
The pull request deployment environment was changed.
This event is available for the following issue types.
Properties for deployment_environment_changed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. 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.
This event is available for the following issue types.
Properties for disconnected Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. head_ref_deleted
The pull request's HEAD branch was deleted.
This event is available for the following issue types.
Properties for head_ref_deleted Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. head_ref_restored
The pull request's HEAD branch was restored to the last known commit.
This event is available for the following issue types.
head_ref_force_pushedThe pull request's HEAD branch was force pushed.
This event is available for the following issue types.
Properties for head_ref_force_pushed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. labeled
A label was added to the issue or pull request.
This event is available for the following issue types.
Properties for labeled Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. label object The label added or removed from the issue label[name] string The name of the label. label[color] string The hex color code. locked
The issue or pull request was locked.
This event is available for the following issue types.
Properties for locked Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. mentioned
The actor was @mentioned in an issue or pull request body.
This event is available for the following issue types.
Properties for mentioned Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. 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.
This event is available for the following issue types.
Properties for marked_as_duplicate Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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.
This event is available for the following issue types.
Properties for merged Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. milestoned
The issue or pull request was added to a milestone.
This event is available for the following issue types.
Properties for milestoned Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. pinned
The issue was pinned.
This event is available for the following issue types.
Properties for pinned Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. ready_for_review
A draft pull request was marked as ready for review.
This event is available for the following issue types.
Properties for ready_for_review Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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.
This event is available for the following issue types.
Properties for referenced Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. renamed
The issue or pull request title was changed.
This event is available for the following issue types.
Properties for renamed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. 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.
This event is available for the following issue types.
Properties for reopened Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. review_dismissed
The pull request review was dismissed.
This event is available for the following issue types.
Properties for review_dismissed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. dismissed_review object The information for the dismissed review. dismissed_review[state] string The state the pull request was in when it was dismissed. Can be one of: commented, approved, or changes_requested. dismissed_review[review_id] string The unique identifier of the pull request's review. dismissed_review[dismissal_message] string The message the user included when dismissing the review. dismissed_review[dismissal_commit_id] string The unique identifier of the commit that dismissed the review if one exists. review_requested
A pull request review was requested.
This event is available for the following issue types.
Properties for review_requested Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. review_request_removed
A pull request review request was removed.
This event is available for the following issue types.
Properties for review_request_removed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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.
This event is available for the following issue types.
Properties for reviewedThis 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 Descriptionid 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, approved or dismissed. 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.
This event is available for the following issue types.
Properties for subscribed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. transferred
The issue was transferred to another repository.
This event is available for the following issue types.
Properties for transferred Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. unassigned
A user was unassigned from the issue.
This event is available for the following issue types.
Properties for unassigned Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. assignee object The person unassigned from this issue. assigner object The person who performed the unassignment for this issue. This field is available in the REST API for issue events but not the REST API for timeline events. unlabeled
A label was removed from the issue.
This event is available for the following issue types.
Properties for unlabeled Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. label object The label added or removed from the issue label[name] string The name of the label. label[color] string The hex color code. unlocked
The issue was unlocked.
This event is available for the following issue types.
Properties for unlocked Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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.
This event is available for the following issue types.
Properties for unmarked_as_duplicate Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. unpinned
The issue was unpinned.
This event is available for the following issue types.
Properties for unpinned Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. unsubscribed
Someone unsubscribed from receiving notifications for an issue or pull request.
This event is available for the following issue types.
Properties for unsubscribed Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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. user_blocked
An organization owner blocked a user from the organization. This was done through one of the blocked user's comments on the issue.
This event is available for the following issue types.
Properties for user_blocked Name Type Descriptionid integer The unique identifier of the event. node_id string The Global Node ID of the event. url string The REST API URL for fetching the event. actor object The person who generated the event. event string 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.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4