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

このバージョンの GitHub Enterprise はこの日付をもって終了となります: 2021-06-09. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの改善、新機能のためには、最新バージョンのGitHub Enterpriseにアップグレードしてください。 アップグレードに関する支援については、GitHub Enterprise supportに連絡してください。

GitHubイベントの種類

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

Enterpriseアカウントは、GitHub Enterprise Cloud、GitHub Enterprise Serverで利用できます。

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

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/1.1 200 OK
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

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

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

CreateEvent

A Git branch or tag is created. For more information, see the "Git data" 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オブジェクト

キー種類説明
refstringThe git ref resource.
ref_typestringリポジトリで作成されたGit refオブジェクトの種類。 branchもしくはtagになる。
master_branchstringThe 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.

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

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

ForkEvent

A user forks a repository. For more information, see the "forks" 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オブジェクト

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

GollumEvent

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

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

キー種類説明
pagesarrayThe pages that were updated.
pages[][page_name]stringThe name of the page.
pages[][title]stringThe current page title.
pages[][action]stringThe action that was performed on the page. Can be created or edited.
pages[][sha]stringThe latest commit SHA of the page.
pages[][html_url]stringPoints 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.

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

キー種類説明
actionstringThe action that was performed on the comment. Can be one of created, edited, or deleted.
changesobjectThe 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.

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

キー種類説明
actionstring実行されたアクション. Can be one of opened, closed, reopened, assigned, unassigned, labeled, or unlabeled.
issueobjectThe 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.

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

キー種類説明
actionstring実行されたアクション. Can be added to indicate a user accepted an invitation to a repository.
memberobjectThe 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.

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

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

PullRequestReviewEvent

Activity related to pull request reviews. The type of activity is specified in the action property of the payload object. For more information, see the "pull request reviews" 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オブジェクト

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

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.

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

キー種類説明
actionstringThe action that was performed on the comment. created になりうる。
changesobjectThe 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.

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

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

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.

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

キー種類説明
actionstring実行されたアクション. 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.

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

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

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.