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.

Example WatchEvent event object

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

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

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

CommitCommentEvent

提交评论已创建。 活动类型在有效负载对象的 action 属性中指定。 更多信息请参阅“提交评论”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

CreateEvent

Git 分支或标签已创建。 更多信息请参阅“Git 数据”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

DeleteEvent

Git 分支或标签已删除。 更多信息请参阅“Git 数据”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

ForkEvent

用户复刻仓库。 更多信息请参阅“复刻”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

GollumEvent

创建或更新 wiki 页面。 更多信息请参阅“关于 wikis”。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

IssueCommentEvent

与议题评论相关的活动。 活动类型在有效负载对象的 action 属性中指定。 更多信息请参阅“议题评论”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

IssuesEvent

与议题相关的活动。 活动类型在有效负载对象的 action 属性中指定。 更多信息请参阅“议题”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

MemberEvent

与仓库协作者相关的活动。 活动类型在有效负载对象的 action 属性中指定。 更多信息请参阅“协作者”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

PublicEvent

当私有仓库公开时。 毫无疑问：最好的 GitHub Enterprise Server 事件。

Event payload object

This event returns an empty payload object.

PullRequestEvent

与拉取请求相关的活动。 活动类型在有效负载对象的 action 属性中指定。 更多信息请参阅“拉取请求”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

PullRequestReviewCommentEvent

与拉取请求统一差异中的拉取请求审查评论相关的活动。 活动类型在有效负载对象的 action 属性中指定。 更多信息请参阅“拉取请求审查评论”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

PushEvent

一个或多个提交被推送到仓库分支或标记。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

ReleaseEvent

与发行版相关的活动。 活动类型在有效负载对象的 action 属性中指定。 更多信息请参阅“发行版”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object

WatchEvent

当有人标星仓库时。 活动类型在有效负载对象的 action 属性中指定。 更多信息请参阅“星标”REST API。

事件对象 包含所有事件的通用属性。 每个事件对象都包含 payload 属性，并且该值对于每个事件类型而言都是唯一的。 此事件的 payload 对象如下所述。

Event payload object