GitHub Events API
The GitHub Events API provides a read-only feed of recent activity on GitHub, exposing structured event objects you can poll to see what happened across the platform or within a specific repository, organization, or user account. It covers many event typessuch as pushes, pull requests, issues, comments, releases, stars, forks, and membership changeseach with consistent metadata (actor, repo, type, payload, timestamps, IDs).
GitHub Events API is one of 384 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
12 operations
across 12 paths,
and defines 61 schemas.
It is described by OpenAPI 3.0.3, at version 1.1.4.
Requests are made against a single base URL, {protocol}://{hostname}/api/v3.
The identity and technical contract details declared by the specification.
nullable-simple-user
object
A GitHub user.
21 properties
18 required
integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
event_2
object
Event
8 properties
7 required
repository
object
A repository on GitHub.
95 properties
73 required
nullable-milestone
object
A collection of related issues and pull requests.
16 properties
16 required
reaction-rollup
object
10 properties
10 required
actor
object
Actor
6 properties
5 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
unlabeled-issue-event
object
Unlabeled Issue Event
10 properties
10 required
timeline-cross-referenced-event
object
Timeline Cross Referenced Event
5 properties
4 required
added-to-project-issue-event
object
Added to Project Issue Event
10 properties
9 required
issue-event-label
object
Issue Event Label
2 properties
2 required
converted-note-to-issue-issue-event
object
Converted Note to Issue Issue Event
10 properties
9 required
event
object
Event
8 properties
7 required
nullable-simple-user_3
object
GitHub user.
21 properties
18 required
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties
9 required
basic-error
object
Basic Error
4 properties
labeled-issue-event
object
Labeled Issue Event
10 properties
10 required
nullable-license-simple_3
object
License Simple
6 properties
5 required
timeline-comment-event
object
Timeline Comment Event
16 properties
11 required
moved-column-in-project-issue-event
object
Moved Column in Project Issue Event
10 properties
9 required
review-request-removed-issue-event
object
Review Request Removed Issue Event
12 properties
10 required
issue-event
object
Issue Event
22 properties
8 required
simple-user_3
object
GitHub user.
21 properties
18 required
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
actor_2
object
Actor
6 properties
5 required
nullable-issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
timeline-unassigned-issue-event
object
Timeline Unassigned Issue Event
10 properties
10 required
locked-issue-event
object
Locked Issue Event
10 properties
10 required
nullable-integration_3
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
issue-event-milestone
object
Issue Event Milestone
1 property
1 required
issue-event-project-card
object
Issue Event Project Card
6 properties
5 required
timeline-commit-commented-event
object
Timeline Commit Commented Event
4 properties
commit-comment
object
Commit Comment
14 properties
13 required
assigned-issue-event
object
Assigned Issue Event
11 properties
11 required
review-dismissed-issue-event
object
Review Dismissed Issue Event
10 properties
10 required
repository_3
object
repository on GitHub.
95 properties
73 required
removed-from-project-issue-event
object
Removed from Project Issue Event
10 properties
9 required
review-requested-issue-event
object
Review Requested Issue Event
12 properties
10 required
state-change-issue-event
object
State Change Issue Event
10 properties
9 required
validation-error
object
Validation Error
3 properties
2 required
timeline-committed-event
object
Timeline Committed Event
11 properties
10 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties
16 required
nullable-milestone_3
object
collection of related issues and pull requests.
16 properties
16 required
renamed-issue-event
object
Renamed Issue Event
10 properties
10 required
issue-event-for-issue
Issue Event for Issue
issue-event-dismissed-review
object
4 properties
3 required
timeline-assigned-issue-event
object
Timeline Assigned Issue Event
10 properties
10 required
unassigned-issue-event
object
Unassigned Issue Event
11 properties
11 required
nullable-integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
issue-event-rename
object
Issue Event Rename
2 properties
2 required
demilestoned-issue-event
object
Demilestoned Issue Event
10 properties
10 required
timeline-issue-events
object
Timeline Event
timeline-reviewed-event
object
Timeline Reviewed Event
14 properties
11 required
simple-user
object
A GitHub user.
21 properties
18 required
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
milestoned-issue-event
object
Milestoned Issue Event
10 properties
10 required
nullable-license-simple
object
License Simple
6 properties
5 required
author-association
string
How the author is associated with the repository.
timeline-line-commented-event
object
Timeline Line Commented Event
3 properties
issue_3
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GitHub publishes across the network.
