Skip to main content

GitHub 事件类型

对于 GitHub 事件 API,了解每个事件类型、GitHub 上的触发操作以及每个事件的唯一属性。

事件 API 可以返回 GitHub 上的活动触发的不同类型事件。 每个事件响应都包含共享属性,但具有由其事件类型确定的唯一 payload 对象。 事件对象公共属性描述所有事件共享的属性,而每个事件类型描述特定事件唯一的 payload 属性。

事件对象公共属性

从事件 API 端点返回的事件对象具有相同的结构。

事件 API 属性名称说明
id事件的唯一标识符。
type事件的类型。 事件使用 PascalCase 作为名称。
actor触发事件的用户。
actor.id执行者的唯一标识符。
actor.login执行者的用户名。
actor.display_login用户名的特定显示格式。
actor.gravatar_id执行者的 Gravatar 个人资料的唯一标识符。
actor.url用于检索用户对象的 REST API URL,其中包括更多用户信息。
actor.avatar_url执行者个人资料图像的 URL。
repo发生事件的仓库对象。
repo.id仓库的唯一标识符。
repo.name仓库名称,包括所有者和仓库的名称。 例如,octocat/hello-worldoctocat 个人帐户拥有的 hello-world 存储库的名称。
repo.url用于检索仓库对象的 REST API URL,其中包括更多仓库信息。
payload事件有效负载对象对于事件类型是唯一的。 有关事件 API payload 对象,请参阅下面的事件类型。
public事件是否对所有用户可见。
created_at触发事件的日期和时间。 它根据 ISO 8601 设置格式。
org由行动者选择的组织来执行触发事件的操作。
该属性仅在适用时才会显示在事件对象中。
org.id组织的唯一标识符。
org.login组织名称。
org.gravatar_id组织的 Gravatar 配置文件的唯一标识符。
org.url用于检索组织对象的 REST API URL,其中包括更多组织信息。
org.avatar_url组织的配置文件图像的 URL。

WatchEvent 事件对象示例

此示例显示了使用事件 APIWatchEvent 响应的格式。

HTTP/2 200
Link: <https://api.github.com/resource?page=2>; rel="next",
      <https://api.github.com/resource?page=5>; rel="last"
[
  {
    "type": "WatchEvent",
    "public": false,
    "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 对象描述如下。

事件 payload 对象

密钥类型说明
actionstring已执行的操作。 可以为 created
commentobject提交注释资源。

CreateEvent

Git 分支或标签已创建。 有关详细信息,请参阅“Git 数据库”REST API。

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

事件 payload 对象

密钥类型说明
refstringgit ref 资源。
ref_typestring在仓库中创建的 Git ref 对象的类型。 可以为 branchtag
master_branchstring存储库默认分支的名称(通常为 main)。
descriptionstring仓库的当前描述。

DeleteEvent

Git 分支或标签已删除。 有关详细信息,请参阅“Git 数据库”REST API。

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

事件 payload 对象

密钥类型说明
refstringgit ref 资源。
ref_typestring在存储库中删除的 Git 引用对象的类型。 可以为 branchtag

ForkEvent

用户复刻仓库。 有关详细信息,请参阅“复刻”REST API。

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

事件 payload 对象

密钥类型说明
forkeeobject创建的 repository 资源。

GollumEvent

创建或更新 wiki 页面。 有关详细信息,请参阅“关于 Wikis”。

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

事件 payload 对象

密钥类型说明
pagesarray已更新的页面。
pages[][page_name]string页的名称。
pages[][title]string- 当前页标题。
pages[][action]string- 在该页上执行的操作。 可以是 creatededited
pages[][sha]string页面的最新提交 SHA。
pages[][html_url]string指向 HTML wiki 页面。

IssueCommentEvent

与议题或拉取请求评论相关的活动。 活动类型在有效负载对象的 action 属性中指定。 有关详细信息,请参阅“发布评论”REST API。

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

事件 payload 对象

密钥类型说明
actionstring在评论上执行的操作。 可以是 createdediteddeleted 之一。 changes
changes[body][from]string正文的先前版本(如果操作为 edited)。
issueobject注释所属的议题
commentobject注释本身。

IssuesEvent

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

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

事件 payload 对象

密钥类型说明
actionstring执行的操作内容. 可以是 openededitedclosedreopenedassignedunassignedlabeledunlabeled 之一。 issue
changesobject对问题的更改(如果操作为 edited)。
changes[title][from]string先前版本的标题(如果操作为 edited)。
changes[body][from]string先前版本的正文(如果操作为 edited)。
assigneeobject已分配或未分配问题的可选用户。
labelobject从问题中添加或删除的可选标签。

MemberEvent

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

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

事件 payload 对象

密钥类型说明
actionstring执行的操作内容. 可以是 added 以指示用户接受了加入存储库的邀请。 member
changesobject如果操作是 edited,则是对参与者权限的更改。
changes[old_permission][from]string如果操作是 edited,则为协作者以前的权限。

PublicEvent

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

事件 payload 对象

此事件返回一个空 payload 对象。

PullRequestEvent

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

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

事件 payload 对象

密钥类型说明
actionstring执行的操作内容. 可以是 openededitedclosedreopenedassignedunassignedreview_requestedreview_request_removedlabeledunlabeledsynchronize 其中之一。 number
changesobject对注释的更改(如果操作为 edited)。
changes[title][from]string先前版本的标题(如果操作为 edited)。
changes[body][from]string先前版本的正文(如果操作为 edited)。
pull_requestobject拉取请求 本身。

PullRequestReviewEvent

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

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

事件 payload 对象

密钥类型说明
actionstring执行的操作内容. 可以为 created
pull_requestobject与审查相关的拉取请求。
reviewobject受影响的审查。

PullRequestReviewCommentEvent

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

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

事件 payload 对象

密钥类型说明
actionstring在评论上执行的操作。 可以为 createdchanges
changes[body][from]string正文的先前版本(如果操作为 edited)。
pull_requestobject注释所属于的拉取请求
commentobject注释本身。

PullRequestReviewThreadEvent

与拉取请求的批注线程相关的活动标记为已解决或未解决。 活动类型在有效负载对象的 action 属性中指定。

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

事件 payload 对象

密钥类型说明
actionstring执行的操作内容. 可以是以下选项之一:
  • resolved - 拉取请求上的批注线程被标记为已解决。
  • unresolved - 拉取请求上先前已解决的批注线程标记为未解决。
pull_requestobject与线程相关的拉取请求
threadobject受影响的线程。

PushEvent

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

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

事件 payload 对象

密钥类型说明
push_idinteger推送的唯一标识符。
sizeinteger推送中的提交数。
distinct_sizeinteger推送中不同提交的数量。
refstring推送的完整 git ref。 示例:refs/heads/main
headstring推送之后在 ref 上最近提交的 SHA。
beforestring推送之前在 ref 上最近提交的 SHA。
commitsarray描述所推送提交的提交对象数组。 (该数组最多包含 20 个提交。 如有必要,可使用提交 API 获取更多提交。 此限制仅适用于时间表事件,而不适用于 web 挂钩递送。)
commits[][sha]string提交的 SHA。
commits[][message]string提交消息。
commits[][author]object提交的 Git 作者。
commits[][author][name]stringGit 作者的名称。
commits[][author][email]stringGit 作者的电子邮件地址。
commits[][url]url指向提交 API 资源的 URL。
commits[][distinct]boolean此提交是否与之前推送的任何提交不同。

ReleaseEvent

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

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

事件 payload 对象

密钥类型说明
actionstring执行的操作内容. 可以为 publishedchanges[body][from]
changes[name][from]string如果操作是 edited,则为先前版本的名称。
releaseobjectrelease 对象。

WatchEvent

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

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

事件 payload 对象

密钥类型说明
actionstring执行的操作内容. 目前只能是 started