Events

This is a read-only API to the GitHub events. These events power the various activity streams on the site.

The Events API can return different types of events triggered by activity on GitHub. For more information about the specific events that you can receive from the Events API, see "Event types and payloads." An events API for repository issues is also available. For more information, see the "Issue Events API."

Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.

curl -I https://api.github.com/users/tater/events
HTTP/1.1 200 OK
X-Poll-Interval: 60
ETag: "a18c3bded88eb5dbb5c849a489412bf3"
# The quotes around the ETag value are important
curl -I https://api.github.com/users/tater/events \
   -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"'
HTTP/1.1 304 Not Modified
X-Poll-Interval: 60

Events support pagination, however the per_page option is unsupported. The fixed page size is 30 items. Fetching up to ten pages is supported, for a total of 300 events.

Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300).

List public events

We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.

GET /events

List repository events

GET /repos/:owner/:repo/events

List public events for a network of repositories

GET /networks/:owner/:repo/events

List public organization events

GET /orgs/:org/events

List events received by the authenticated user

These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.

GET /users/:username/received_events

List public events received by a user

GET /users/:username/received_events/public

List events for the authenticated user

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.

GET /users/:username/events

List public events for a user

GET /users/:username/events/public

List organization events for the authenticated user

This is the user's organization dashboard. You must be authenticated as the user to view this.

GET /users/:username/events/orgs/:org