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.

Name	Type	Description
`id`	`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.

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.

Name	Type	Description
`id`	`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.
`project_card`	`object`	The project card object.
`project_id`	`integer`	The unique identifier of the project card.
`project_url`	`string`	The REST API URL to retrieve the project card.
`column_name`	`string`	The name of the column the issue is in.

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

Name	Type	Description
`id`	`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.

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

Name	Type	Description
`id`	`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.

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.
`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.

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.
`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".

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

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.

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

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
`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

Name	Type	Description
`id`	`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.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	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.
`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_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.

Name	Type	Description
`id`	`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.
`project_card`	`object`	The project card object.
`project_id`	`integer`	The unique identifier of the project card.
`project_url`	`string`	The REST API URL to retrieve the project card.
`column_name`	`string`	The name of the column the issue is in.

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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	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.
`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.

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.
`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".

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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 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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

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.

Name	Type	Description
`id`	`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.
`project_card`	`object`	The project card object.
`project_id`	`integer`	The unique identifier of the project card.
`project_url`	`string`	The REST API URL to retrieve the project card.
`column_name`	`string`	The name of the column the issue is in.
`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

Name	Type	Description
`id`	`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 pull request was created that is not in draft mode.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

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.

Name	Type	Description
`id`	`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.
`project_card`	`object`	The project card object.
`project_id`	`integer`	The unique identifier of the project card.
`project_url`	`string`	The REST API URL to retrieve the project card.
`column_name`	`string`	The name of the column the issue is in.

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

Name	Type	Description
`id`	`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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	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.
`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.

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.

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

Name	Type	Description
`id`	`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.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

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

Name	Type	Description
`id`	`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 removed from the issue
`label[name]`	`string`	The name of the label.
`label[color]`	`string`	The hex color code.

unlocked

The issue was unlocked.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	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.
`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.

Availability

Issue type	Issue events API	Timeline events API
Issues 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.
`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.

In this article

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

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

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

moved_columns_in_project

Availability

Event object properties

pinned

Availability