GitHub event types

The Events API can return different types of events triggered by activity on GitHub. Each event response contains shared properties, but has a unique payload object determined by its event type. The Event object common properties describes the properties shared by all events, and each event type describes the payload properties that are unique to the specific event.

Event object common properties

The event objects returned from the Events API endpoints have the same structure.

Event API attribute name	Type	Description
id	integer	Unique identifier for the event.
type	string	The type of event. Events uses PascalCase for the name.
actor	object	The user that triggered the event.
actor.id	integer	The unique identifier for the actor.
actor.login	string	The username of the actor.
actor.display_login	string	The specific display format of the username.
actor.gravatar_id	string	The unique identifier of the Gravatar profile for the actor.
actor.url	string	The REST API URL used to retrieve the user object, which includes additional user information.
actor.avatar_url	string	The URL of the actor's profile image.
repo	object	The repository object where the event occurred.
repo.id	integer	The unique identifier of the repository.
repo.name	string	The name of the repository, which includes the owner and repository name. For example, octocat/hello-world is the name of the hello-world repository owned by the octocat personal account.
repo.url	string	The REST API URL used to retrieve the repository object, which includes additional repository information.
payload	object	The event payload object is unique to the event type. See the event type below for the event API payload object.
public	boolean	Whether the event is visible to all users.
created_at	string	The date and time when the event was triggered. It is formatted according to ISO 8601.
org	object	The organization that was chosen by the actor to perform action that triggers the event. The property appears in the event object only if it is applicable.
org.id	integer	The unique identifier for the organization.
org.login	string	The name of the organization.
org.gravatar_id	string	The unique identifier of the Gravatar profile for the organization.
org.url	string	The REST API URL used to retrieve the organization object, which includes additional organization information.
org.avatar_url	string	The URL of the organization's profile image.

Example WatchEvent event object

This example shows the format of the WatchEvent response when using the Events API.

HTTP/2 200
Link: <https://api.github.com/resource?page=2>; rel="next",
      <https://api.github.com/resource?page=5>; rel="last"

[
  {
    "id": "12345",
    "type": "WatchEvent",
    "actor": {
      "id": 1,
      "login": "octocat",
      "display_login": "octocat",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif"
    },
    "repo": {
      "id": 3,
      "name": "octocat/Hello-World",
      "url": "https://api.github.com/repos/octocat/Hello-World"
    },
    "payload": {
      "action": "started"
    },
    "public": false,
    "created_at": "2011-09-06T17:26:27Z",
    "org": {
      "id": 1,
      "login":