docs/content/developers/webhooks-and-events/issue-event-types.md

title	intro	redirect_from	versions
Issue event types	For the Issues Events API and Timeline API, learn about each event type, the triggering action on {% data variables.product.prodname_dotcom %}, and each event's unique properties.	[/v3/issues/issue-event-types]	[{free-pro-team *} {enterprise-server *} {github-ae *}]

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.

{% data reusables.issue-events.issue-event-common-properties %}

added_to_project

The issue or pull request was added to a project board. {% data reusables.projects.disabled-projects %}

Availability

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

Event object properties

{% data reusables.pre-release-program.starfox-preview %} {% data reusables.pre-release-program.api-preview-warning %}

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.project-card-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.assignee-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.timeline_events_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

{% data reusables.issue-events.timeline_events_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.
verfication	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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

converted_note_to_issue

The issue was created by converting a note in a project board to an issue. {% data reusables.projects.disabled-projects %}

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

{% data reusables.pre-release-program.starfox-preview %} {% data reusables.pre-release-program.api-preview-warning %}

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.project-card-properties %}

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

{% data reusables.issue-events.timeline_events_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

{% data reusables.issue-events.issue-event-common-properties %} 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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.label-properties %}

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

{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} {% data reusables.pre-release-program.sailor-v-preview %} {% data reusables.pre-release-program.api-preview-warning %} {% endif %}

{% data reusables.issue-events.issue-event-common-properties %} 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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %} 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. {% data reusables.projects.disabled-projects %}

Availability

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

Event object properties

{% data reusables.pre-release-program.starfox-preview %} {% data reusables.pre-release-program.api-preview-warning %}

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.project-card-properties %} 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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

removed_from_project

The issue or pull request was removed from a project board. {% data reusables.projects.disabled-projects %}

Availability

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

Event object properties

{% data reusables.pre-release-program.starfox-preview %} {% data reusables.pre-release-program.api-preview-warning %}

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.project-card-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %} 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

{% data reusables.issue-events.issue-event-common-properties %}

review_dismissed

The pull request review was dismissed.

Availability

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

Event object properties

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.review-dismissed-properties %}

review_requested

A pull request review was requested.

Availability

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

Event object properties

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.review-request-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.review-request-properties %}

reviewed

The pull request was reviewed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests		X

Event object properties

{% data reusables.issue-events.timeline_events_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

{% data reusables.issue-events.issue-event-common-properties %}

transferred

The issue was transferred to another repository.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.assignee-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %} {% data reusables.issue-events.label-properties %}

unlocked

The issue was unlocked.

Availability

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

Event object properties

{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} {% data reusables.pre-release-program.sailor-v-preview %} {% data reusables.pre-release-program.api-preview-warning %} {% endif %}

{% data reusables.issue-events.issue-event-common-properties %} 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

{% data reusables.issue-events.issue-event-common-properties %}

unpinned

The issue was unpinned.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

{% data reusables.issue-events.issue-event-common-properties %}

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

{% data reusables.issue-events.issue-event-common-properties %}

{% if currentVersion == "free-pro-team@latest" %}

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.

Availability

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

Event object properties

{% data reusables.issue-events.issue-event-common-properties %}

{% endif %}