GitHubイベントの種類

GitHub Event APIについて、各イベントの種類、GitHub上でのトリガーするアクション、各イベント固有のプロパティについて学んでください。

Enterprise accounts are available with GitHub Enterprise Cloud and GitHub Enterprise Server.

ここには以下の内容があります:

イベントオブジェクトの共通プロパティ
CommitCommentEvent
CreateEvent
DeleteEvent
ForkEvent
GollumEvent
IssueCommentEvent
IssuesEvent
MemberEvent
PublicEvent
PullRequestEvent
PullRequestReviewCommentEvent
PushEvent
ReleaseEvent
WatchEvent

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のレスポンスの形式を示しています。

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

A commit comment is created. The type of activity is specified in the action property of the payload object. For more information, see the "commit comment" REST API.

The event object includes properties that are common for all events. Each event object includes a payload property and the value is unique to each event type. The payload object for this event is described below.

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

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

CreateEvent

A Git branch or tag is created. For more information, see the "Git data" REST API.

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

キー	種類	説明
`ref`	`string`	The `git ref` resource.
`ref_type`	`string`	リポジトリで作成されたGit refオブジェクトの種類。 `branch`もしくは`tag`になる。
`master_branch`	`string`	The name of the repository's default branch (usually `master`).
`説明`	`string`	リポジトリの現在の説明。

DeleteEvent

A Git branch or tag is deleted. For more information, see the "Git data" REST API.

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

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

ForkEvent

A user forks a repository. For more information, see the "forks" REST API.

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

キー	種類	説明
`forkee`	`オブジェクト`	The created `repository` resource.

GollumEvent

A wiki page is created or updated. For more information, see the "About wikis".

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

キー	種類	説明
`pages`	`array`	The pages that were updated.
`pages[][page_name]`	`string`	The name of the page.
`pages[][title]`	`string`	The current page title.
`pages[][action]`	`string`	The action that was performed on the page. Can be `created` or `edited`.
`pages[][sha]`	`string`	The latest commit SHA of the page.
`pages[][html_url]`	`string`	Points to the HTML wiki page.

IssueCommentEvent

Activity related to an issue comment. The type of activity is specified in the action property of the payload object. For more information, see the "issue comments" REST API.

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

キー	種類	説明
`action`	`string`	The action that was performed on the comment. Can be one of `created`, `edited`, or `deleted`.
`changes`	`object`	The changes to the comment if the action was `edited`. `changes[body][from]`

IssuesEvent

Activity related to an issue. The type of activity is specified in the action property of the payload object. For more information, see the "issues" REST API.

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

キー	種類	説明
`action`	`string`	実行されたアクション. Can be one of `opened`, `closed`, `reopened`, `assigned`, `unassigned`, `labeled`, or `unlabeled`.
`issue`	`object`	The issue itself. `changes`

MemberEvent

Activity related to repository collaborators. The type of activity is specified in the action property of the payload object. For more information, see the "collaborators" REST API.

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

キー	種類	説明
`action`	`string`	実行されたアクション. Can be `added` to indicate a user accepted an invitation to a repository.
`member`	`object`	The user that was added. `changes`

PublicEvent

When a private repository is made public. Without a doubt: the best GitHub Enterprise Server event.

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

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

PullRequestEvent

Activity related to pull requests. The type of activity is specified in the action property of the payload object. For more information, see the "pull requests" REST API.

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

キー	種類	説明
`action`	`string`	実行されたアクション. Can be one of `opened`, `closed`, `reopened`, `assigned`, `unassigned`, `review_requested`, `review_request_removed`, `labeled`, `unlabeled`, and `synchronize`.
`number`	`integer`	The pull request number. `changes`

PullRequestReviewCommentEvent

Activity related to pull request review comments in the pull request's unified diff. The type of activity is specified in the action property of the payload object. For more information, see the "pull request review comments" REST API.

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

キー	種類	説明
`action`	`string`	The action that was performed on the comment. `created` になりうる。
`changes`	`object`	The changes to the comment if the action was `edited`. `changes[body][from]`

PushEvent

One or more commits are pushed to a repository branch or tag.

キー	種類	説明
`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

Activity related to a release. The type of activity is specified in the action property of the payload object. For more information, see the "releases" REST API.

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

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

WatchEvent

When someone stars a repository. The type of activity is specified in the action property of the payload object. For more information, see the "starring" REST API.

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

キー	種類	説明
`action`	`string`	実行されたアクション. Currently, can only be `started`.

GitHubイベントの種類

Still need help?