Issue Events API

Records various events that occur around an Issue or Pull Request. This is useful both for display on issue/pull request information pages and also to determine who should be notified of comments.

Attributes

actor

Always the User 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.

Events

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.

reopened

The issue was reopened by the actor.

subscribed

The actor subscribed to receive notifications for an issue.

merged

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

referenced

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

mentioned

The actor was @mentioned in an issue body.

assigned

The issue was assigned to the actor.

List events for an issue

GET /repos/:user/:repo/issues/:issue_id/events

Response

Status: 200 OK
X-Next: https://api.github.com/resource?page=2
X-Last: https://api.github.com/resource?page=5
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999

[
  {
    "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
    "actor": {
      "login": "octocat",
      "id": 1,
      "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
      "url": "https://api.github.com/users/octocat"
    },
    "event": "closed",
    "commit_id": "SHA",
    "created_at": "2011-04-14T16:00:49Z"
  }
]

List events for a repository

GET /repos/:user/:repo/issues/events

Response

Status: 200 OK
X-Next: https://api.github.com/resource?page=2
X-Last: https://api.github.com/resource?page=5
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999

[
  {
    "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
    "actor": {
      "login": "octocat",
      "id": 1,
      "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
      "url": "https://api.github.com/users/octocat"
    },
    "event": "closed",
    "commit_id": "SHA",
    "created_at": "2011-04-14T16:00:49Z"
  }
]

Get a single event

GET /repos/:user/:repo/issues/events/:id

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999

{
  "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
  "actor": {
    "login": "octocat",
    "id": 1,
    "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
    "url": "https://api.github.com/users/octocat"
  },
  "event": "closed",
  "commit_id": "SHA",
  "created_at": "2011-04-14T16:00:49Z"
}