GitHubイベントの種類

Events APIは、GitHub上のアクティビティによってトリガーされる様々な種類のイベントを返します。 各イベントのレスポンスは共有プロパティを含むとともに、イベントの種類によって決まる固有のpayloadオブジェクトを持ちます。 イベントオブジェクトの共通プロパティは、すべてのイベントが共有するプロパティを示すものであり、各イベントの種類にはそのイベントに固有のpayloadプロパティが示されています。

イベントオブジェクトの共通プロパティ

Events APIエンドポイントから返されるイベントオブジェクトは、同じ構造を持ちます。

Event 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-worldは、octocatユーザアカウントが所有するhello-worldリポジトリの名前。
repo.url	追加のリポジトリ情報を含むリポジトリオブジェクトの取得に使われるREST APIのURL。
payload	イベントの種類に固有のイベントペイロードオブジェクト。 イベントAPIのpayloadオブジェクトについては、以下のイベントの種類を参照してください。

WatchEventイベントのオブジェクトの例

この例は、Events APIを使用する際のWatchEventのレスポンスの形式を示しています。

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オブジェクト

キー	種類	説明
action	string	実行されたアクション。 created になりうる。
コメント	オブジェクト	commit commentリソース。

CreateEvent

Gitブランチもしくはタグが作成されました。 詳しい情報については「Gitデータ」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
ref	string	git refリソース。
ref_type	string	リポジトリで作成されたGit refオブジェクトの種類。 branchもしくはtagになる。
master_branch	string	リポジトリのデフォルトブランチの名前（通常はmaster）。
description	string	リポジトリの現在の説明。

DeleteEvent

Gitブランチまたはタグが削除されました。 詳しい情報については「Gitデータ」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
ref	string	git refリソース。
ref_type	string	リポジトリで削除されたGit refオブジェクトの種類。 branchもしくはtagになる。

ForkEvent

ユーザがリポジトリをフォークします。 詳しい情報については「forks」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
forkee	オブジェクト	作成されたrepositoryリソース。

GollumEvent

wikiページが作成もしくは更新されました。 詳しい情報については「wikiについて」を参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
pages	array	更新されたページ。
pages[][page_name]	string	ページの名前。
pages[][title]	string	現在のページのタイトル。
pages[][action]	string	ページ上で行われたアクション。 createdもしくはeditedのいずれか。
pages[][sha]	string	ページの最新のコミットSHA。
pages[][html_url]	string	HTMLのwikiページを指す。

IssueCommentEvent

IssueあるいはPull Requestコメントに関連するアクティビティ。 アクティビティのタイプは、ペイロードオブジェクトのactionプロパティで指定されます。 詳しい情報については「Issueコメント" REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
action	string	コメント上で実行されたアクション。 created、edited、deletedのいずれか。
changes	object	アクションがeditedだった場合のコメントへの変更。 changes[body][from]

IssuesEvent

Issueに関連するアクティビティ。 アクティビティのタイプは、ペイロードオブジェクトのactionプロパティで指定されます。 詳しい情報については「Issue」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
action	string	実行されたアクション. opened、closed、reopened、assigned、unassigned、labeled、unlabeledのいずれか。
issue	object	Issue自体。 changes

MemberEvent

リポジトリのコラボレータに関連するアクティビティ。 アクティビティのタイプは、ペイロードオブジェクトのactionプロパティで指定されます。 詳しい情報については「コラボレータ」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
action	string	実行されたアクション. addedになり、ユーザがリポジトリへの招待を承認したことを示します。
member	object	追加されたユーザ。 changes

PublicEvent

プライベートリポジトリがパブリックにされたとき。 間違いなく: 最高のGitHub Enterprise Serverイベント。

イベントのpayloadオブジェクト

このイベントは、空のpayloadオブジェクトを返します。

PullRequestEvent

Pull Requestに関連するアクティビティ。 アクティビティのタイプは、ペイロードオブジェクトのactionプロパティで指定されます。 詳しい情報については「Pull Request」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
action	string	実行されたアクション. opened、closed、reopened、assigned、unassigned、review_requested、review_request_removed、labeled、unlabeled、synchronizeのいずれか。
number	integer	Pull Requestの番号。 changes

PullRequestReviewEvent

Pull Requestレビューに関連するアクティビティ。 アクティビティのタイプは、ペイロードオブジェクトのactionプロパティで指定されます。 詳しい情報については「Pull Requestレビュー」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
action	string	実行されたアクション. created になりうる。
pull_request	オブジェクト	The pull request the review pertains to.
レビュー	オブジェクト	影響されるレビュー。

PullRequestReviewCommentEvent

Pull Requestの統合diff中のPull Requestレビューコメントに関連するアクティビティ。 アクティビティのタイプは、ペイロードオブジェクトのactionプロパティで指定されます。 詳しい情報については「Pull Requestのレビューコメント」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
action	string	コメント上で実行されたアクション。 created になりうる。
changes	object	アクションがeditedの場合、コメントへの変更。 changes[body][from]

PushEvent

リポジトリのブランチもしくはタグに、1つ以上のコミットがプッシュされました。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
push_id	integer	プッシュの一意の識別子。
size	integer	プッシュ中のコミット数。
distinct_size	integer	プッシュ中の個別のコミット数。
ref	string	プッシュされた完全なgit ref。 例:refs/heads/main。
head	string	プッシュ後のref上の最新のコミットのSHA。
before	string	プッシュ前のref 上の最新のコミットのSHA。
commits	array	プッシュされたコミットを示すコミットオブジェクトの配列。 （配列には最大で20のコミットが含まれる。 必要な場合は、追加のコミットをCommits APIを使ってフェッチできる。 この制限はタイムラインイベントにのみ適用され、webhookの配信には適用されない）
commits[][sha]	string	コミットのSHA。
commits[][message]	string	コミットメッセージ。
commits[][author]	オブジェクト	コミットのGit作者。
commits[][author][name]	string	Git作者の名前。
commits[][author][email]	string	Git作者のメールアドレス。
commits[][url]	url	コミットAPIのリソースを指すURL。
commits[][distinct]	boolean	このコミットが以前にプッシュされたいずれとも異なっているか。

ReleaseEvent

リリースに関連するアクティビティ。 アクティビティのタイプは、ペイロードオブジェクトのactionプロパティで指定されます。 詳しい情報については「リリース」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
action	string	実行されたアクション. publishedになりうる。
changes[body][from]	string	アクションがeditedだった場合の、以前のバージョンのbody。 changes[name][from]

WatchEvent

誰かがリポジトリにStarを付けたとき。 アクティビティのタイプは、ペイロードオブジェクトのactionプロパティで指定されます。 詳しい情報については「Star付け」 REST APIを参照してください。

イベントオブジェクトには、すべてのイベントに共通のプロパティが含まれます。 それぞれのイベントオブジェクトにはpayloadプロパティが含まれ、その値はそれぞれのイベントタイプに固有です。 このイベントのpayloadは以下に示します。

イベントのpayloadオブジェクト

キー	種類	説明
action	string	実行されたアクション. 現在はstartedにのみなりうる。