Skip to main content
ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

GitHubイベントの種類

GitHub Event APIについて、各イベントの種類、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リポジトリの名前。オーナーとリポジトリの名前が含まれる。 For example, octocat/hello-world is the name of the hello-world repository owned by the octocat personal account.
repo.url追加のリポジトリ情報を含むリポジトリオブジェクトの取得に使われるREST APIのURL。
payloadイベントの種類に固有のイベントペイロードオブジェクト。 イベントAPIのpayloadオブジェクトについては、以下のイベントの種類を参照してください。
publicWhether the event is visible to all users.
created_atThe date and time when the event was triggered. It is formatted according to ISO 8601.
orgThe 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.idThe unique identifier for the organization.
org.loginThe name of the organization.
org.gravatar_idThe unique identifier of the Gravatar profile for the organization.
org.urlThe REST API URL used to retrieve the organization object, which includes additional organization information.
org.avatar_urlThe URL of the organization's profile image.

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

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

CreateEvent

Gitブランチもしくはタグが作成されました。 For more information, see the "Git database" REST API.

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

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

キー種類説明
refstringgit refリソース。
ref_typestringリポジトリで作成されたGit refオブジェクトの種類。 branchもしくはtagになる。
master_branchstringリポジトリのデフォルトブランチの名前(通常はmain)。
descriptionstringリポジトリの現在の説明。

DeleteEvent

Gitブランチまたはタグが削除されました。 For more information, see the "Git database" REST API.

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

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

キー種類説明
refstringgit refリソース。
ref_typestringThe type of Git ref object deleted in the repository. branchもしくはtagになる。

ForkEvent

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

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

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

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

GollumEvent

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

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

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

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

IssueCommentEvent

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

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

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

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

IssuesEvent

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

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

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

キー種類説明
actionstring実行されたアクション. Can be one of opened, edited, closed, reopened, assigned, unassigned, labeled, or unlabeled.
issueobjectIssue自体。 changes

MemberEvent

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

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

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

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

PublicEvent

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

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

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

PullRequestEvent

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

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

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

キー種類説明
actionstring実行されたアクション. Can be one of opened, edited, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled, and synchronize.
numberintegerPull Requestの番号。 changes

PullRequestReviewEvent

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

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

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

キー種類説明
actionstring実行されたアクション. created になりうる。
pull_requestオブジェクトレビューが関連するプルリクエスト。
レビューオブジェクト影響されるレビュー。

PullRequestReviewCommentEvent

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

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

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

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

PullRequestReviewThreadEvent

Activity related to a comment thread on a pull request being marked as resolved or unresolved. アクティビティのタイプは、ペイロードオブジェクトのactionプロパティで指定されます。

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

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

キー種類説明
actionstring実行されたアクション. 次のいずれかになります。
  • resolved - A comment thread on a pull request was marked as resolved.
  • unresolved - A previously resolved comment thread on a pull request was marked as unresolved.
pull_requestオブジェクトThe pull request the thread pertains to.
スレッドオブジェクトThe thread that was affected.

PushEvent

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

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

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

キー種類説明
push_idintegerプッシュの一意の識別子。
sizeintegerプッシュ中のコミット数。
distinct_sizeintegerプッシュ中の個別のコミット数。
refstringプッシュされた完全なgit ref。 例:refs/heads/main
headstringプッシュ後のref上の最新のコミットのSHA。
beforestringプッシュ前のref 上の最新のコミットのSHA。
commitsarrayプッシュされたコミットを示すコミットオブジェクトの配列。 (配列には最大で20のコミットが含まれる。 必要な場合は、追加のコミットをCommits APIを使ってフェッチできる。 この制限はタイムラインイベントにのみ適用され、webhookの配信には適用されない)
commits[][sha]stringコミットのSHA。
commits[][message]stringコミットメッセージ。
commits[][author]オブジェクトコミットの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実行されたアクション. publishedになりうる。
changes[body][from]stringアクションがeditedだった場合の、以前のバージョンのbody。 changes[name][from]

WatchEvent

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

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

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

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