Timeline

Records various events that occur around an issue or pull request. This is
useful both for display on issue and pull request information pages, as well as to
determine who should be notified of comments.

Attributes

id

The Integer ID of the event.

url

The API URL for fetching the event.

actor

The User object that generated the event.

commit_id

The String SHA of a commit that referenced this Issue.

event

Identifies the actual type of Event that occurred.

created_at

The timestamp indicating when the event occurred.

label

The Label object including `name` and `color` attributes. Only provided for `labeled`
and `unlabeled` events.

assignee

The User object which was assigned to (or unassigned from) this Issue. Only provided for `assigned` and `unassigned` events.

dismissed_review

A `dismissed_review` object that includes the `state`, `review_id`, `dismissal_message`, and `dismissal_commit_id` (the ID of the commit that dismissed the review) if one exists. Possible `state` strings include `commented`, `approved`, or `changes_requested`. Only provided for `review_dismissed` events.

milestone

The Milestone object including a `title` attribute. Only provided for `milestoned` and
`demilestoned` events.

source

The `id`, `actor`, and `url` for the source of a reference from
another issue. Only provided for `cross-referenced` events.

rename

An object containing rename details including `from` and `to` attributes. Only
provided for `renamed` events.

Events

added_to_project

The issue was added to a project board.

assigned

The issue was assigned to the assignee.

closed

The issue was closed by the actor. When the commit_id is present, it
identifies the commit that closed the issue using "closes / fixes #NN"
syntax.

commented

A comment was added to the issue.

committed

A commit was added to the pull request's `HEAD` branch. Only
provided for pull requests.

converted_note_to_issue

The issue was created by converting a note in a project board to an issue.

cross-referenced

The issue was referenced from another issue. The `source`
attribute contains the `id`, `actor`, and `url` of the reference's
source.

demilestoned

The issue was removed from a milestone.

head_ref_deleted

The pull request's branch was deleted.

head_ref_restored

The pull request's branch was restored.

labeled

A label was added to the issue.

locked

The issue was locked by the actor.

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.

mentioned

The actor was @mentioned in an issue body.

merged

The issue was merged by the actor. The `commit_id` attribute is the SHA1 of
the HEAD commit that was merged.

milestoned

The issue was added to a milestone.

moved_columns_in_project

The issue was moved between columns in a project board.

referenced

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

removed_from_project

The issue was removed from a project board.

renamed

The issue title was changed.

reopened

The issue was reopened by the actor.

review_dismissed

The actor dismissed a review from the pull request.

review_requested

The actor requested a review from the subject on this pull request.

review_request_removed

The actor removed the review request for the subject on this pull request.

subscribed

The actor subscribed to receive notifications for an issue.

unassigned

The assignee was unassigned from the issue.

unlabeled

A label was removed from the issue.

unlocked

The issue was unlocked by the actor.

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.

unsubscribed

The actor unsubscribed to stop receiving notifications for an issue.

Note: The project-related events added_to_project, moved_columns_in_project, removed_from_project, and converted_note_to_issue will not be included in the response if project boards have been disabled in the repository.