Skip to main content

課題イベントタイプ

issue イベントとタイムライン イベント用の REST API について、各イベントの種類、GitHub でのトリガー アクション、各イベントの固有のプロパティについて説明します。

issue イベントは、issue と pull request のアクティビティによってトリガーされ、issue イベントタイムライン イベント用の REST API で使用できます。 各イベントの種類によって、イベントが issue イベントまたはタイムライン イベント用の REST API で使用可能かどうかが指定されます。

GitHubの REST API は、すべてのプル要求を問題と見なしますが、すべての問題がプル要求であるとは考えていません。 このため、Issue イベントエンドポイントとタイムラインイベントエンドポイントは、レスポンスで Issue とプルリクエストの両方を返す場合があります。 pull request には pull_request オブジェクト内の issue プロパティがあります。 プルリクエストは Issue のため、リポジトリ内で Issue とプルリクエストの番号が重複することはありません。 たとえば、リポジトリで最初の Issue を開くと、番号は 1 になります。 次にプルリクエストを開くと、番号は 2 になります。 各イベントタイプでは、イベントがプルリクエスト、Issue、またはその両方で発生するかどうかを指定します。

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

タイムライン イベント用の REST API でのみ使用可能なイベントを除いて、issue イベントはすべて同じオブジェクト構造になっています。 一部のイベントには、イベントリソースに関するより多くのコンテキストを提供する追加のプロパティも含まれています。 このオブジェクト形式とは異なるプロパティについて詳しくは、特定のイベントを参照してください。

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

割り当て済み

Issueまたはプルリクエストがユーザに割り当てられた。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

assigned のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。
assigneeobjectこの Issue に割り当てられたユーザー。
          `assigner`
           | 
          `object` | この issue からの割り当てを実行したユーザー。 このフィールドは、issue イベントに関する REST API では使用できますが、タイムライン イベントに関する REST API では使用できません。

自動ベース変更失敗

GitHub、プル要求のベース ブランチを自動的に変更できませんでした。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

"automatic_base_change_failed" のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

自動ベース変更が成功しました

GitHubはプルリクエストのベースブランチを自動的に変更することに成功しました。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

automatic_base_change_succeeded のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

ベース参照変更

プルリクエストのベースリファレンスブランチが変更された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

base_ref_changed のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

閉じた

Issue またはプルリクエストがクローズされた。 commit_id が存在する場合は、"closes / fixes" 構文を使用して Issue を閉じたコミットを示します。 構文の詳細については、「プルリクエストを課題にリンクする」を参照してください。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

closed のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

コメントあり

Issue またはプルリクエストにコメントが追加された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

commented のプロパティ

このイベント プロパティは、Issue イベント オブジェクトの共通プロパティと同じ構造を使用しません。 このイベントに対しては、以下の属性が返されます。

名前タイプ説明
urlstringIssueコメントを取得するためのREST APIのURL。
html_urlstringIssue コメントの HTML URL。
issue_urlstring問題のHTML URL。
idintegerイベントのユニーク識別子。
node_idstringイベントのグローバル ノード ID
userobjectこの Issue についてコメントしたユーザ。
created_atstringコメントの追加日時を示すタイムスタンプ。
updated_atstringコメントが更新されていない場合に、コメントの更新または作成日時を示すタイムスタンプ。
author_associationstringIssue のリポジトリでユーザが保持している権限。 たとえば、リポジトリの所有者がコメントを作成した場合は、値は "OWNER" です。
bodystringコメント本文テキスト。
eventstringイベントの値は "commented" です。
actorobjectイベントを生成したユーザ。

コミット (committed)

コミットが pull request の HEAD ブランチに追加されました。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

committed のプロパティ

このイベント プロパティは、Issue イベント オブジェクトの共通プロパティと同じ構造を使用しません。 このイベントに対しては、以下の属性が返されます。

名前タイプ説明
shastringプルリクエスト内コミットのハッシュ値 (SHA)
node_idstringイベントのグローバル ノード ID
urlstringコミットを取得する REST API URL。
html_urlstringコミットの HTML URL。
authorobjectコミットの作者。
committerobject作者に代わってコミットしたユーザ。
treeobjectコミットの Git ツリー。
messagestringコミットメッセージ。
parentsarray of objects親コミットのリスト。
verificationobjectコミットの署名の検証結果。 詳しくは、「Git コミット用 REST API エンドポイント」をご覧ください。
eventstringイベントの値は "committed" です。

接続済み

Issue またはプルリクエストが、別の Issue またはプルリクエストにリンクされた。 詳しくは、「プルリクエストを課題にリンクする」をご覧ください。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

connected のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

下書きに変換する

プルリクエストがドラフトモードに変換された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

「convert_to_draft」機能のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

ディスカッションに変換されました

問題は終了となり、ディスカッションに変換されました。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題

converted_to_discussion のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

相互参照された

Issue またはプルリクエストが、別の Issue またはプルリクエストから参照された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

cross-referenced のプロパティ

このイベント プロパティは、Issue イベント オブジェクトの共通プロパティと同じ構造を使用しません。 このイベントに対しては、以下の属性が返されます。

名前タイプ説明
actorobjectイベントを生成したユーザ。
created_atstringクロスリファレンスの追加日時を示すタイムスタンプ。
updated_atstringクロスリファレンスが更新されていない場合、クロスリファレンスの更新または作成時期を示すタイムスタンプ。
sourceobjectクロスリファレンスを追加した Issue またはプルリクエスト。
source[type]stringpull request は Issue 型であるため、この値は常に "issue" になります。 タイムライン イベント用の REST API では、issue または pull request によってトリガーされたクロスリファレンス イベントのみが返されます。 イベントをトリガーした Issue が pull request であるかどうかを判断するには、source[issue][pull_request] オブジェクトが存在するかどうかをチェックします。
source[issue]objectクロスリファレンスを追加した issue オブジェクト。
eventstringイベントの値は "cross-referenced" です。

マイルストーンを解除

Issue またはプルリクエストがマイルストーンから削除された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

demilestoned のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。
milestoneobjectマイルストーン オブジェクト。
          `milestone[title]`
           | 
          `string` | マイルストーンのタイトル。

配備された

プルリクエストがデプロイされた。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

deployed のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

デプロイメント環境が変更されました

プルリクエストのデプロイメント環境が変更された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

デプロイメント環境変更のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

切断

Issue またはプルリクエストが、別の Issue またはプルリクエストからリンク解除された。 詳しくは、「プルリクエストを課題にリンクする」をご覧ください。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

未接続の特性

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

head_ref_deleted (ヘッド参照削除済み)

pull request の HEAD ブランチが削除されました。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

head_ref_deleted のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

head_ref_restored

pull request の HEAD ブランチが、最後の既知のコミットに復元されました。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

head_ref_を強制プッシュしました

pull request の HEAD ブランチが強制的にプッシュされました。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

head_ref_force_pushed のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

ラベル付け済み

Issue またはプルリクエストにラベルが追加された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

labeled のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。label
label[color]string16 進数カラー コード。

ロックされている

Issue またはプルリクエストがロックされた。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

ロックのプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。
lock_reasonstringIssue または pull request の会話がロックされた理由 (指定されている場合)。

mentioned

          `actor` は Issue または pull request 本文内の `@mentioned` でした。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

mentioned のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

重複としてマークされました

書き込み権限を持つユーザが、Issue を別の Issue の複製としてマークしたか、プルリクエストを別のプルリクエストの複製としてマークした。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

marked_as_duplicate のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

マージされた

プルリクエストがマージされた。 commit_id 属性は、マージされた HEAD コミットの SHA1 です。 commit_repository は、常にメイン リポジトリと同じです。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

merged のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

マイルストーンを設定した

Issue またはプルリクエストがマイルストーンに追加された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

milestoned のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。
milestoneobjectマイルストーン オブジェクト。
          `milestone[title]`
           | 
          `string` | マイルストーンのタイトル。

pinned

Issue がピン留めされた。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題

pinned のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

レビューの準備ができました

ドラフト pull request はレビューの準備完了とマークされました。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

ready_for_review のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

参照された

問題はコミットメッセージから取り上げられた。 commit_id 属性はそれが発生した場所のコミット SHA1 であり、commit_repository はそのコミットがプッシュされた場所です。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

参照のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

名前を変更

Issue またはプルリクエストのタイトルが変更された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

renamed のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。
renameobject名前の詳細。
          `rename[from]`
           | 
          `string` | 以前の名前。

          `rename[to]`
           | 
          `string` | 新しい名前。

reopened

Issue またはプルリクエストが再開された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

reopened のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

レビューが却下された

プルリクエストのレビューが却下された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

review_dismissed のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。dismissed_review
dismissed_review[state]stringpull request が無視されたときの状態。 commentedapproved、または changes_requested のいずれかにすることができます。
dismissed_review[review_id]stringpull request のレビューの一意の識別子。
dismissed_review[dismissal_message]stringレビューを閉じるときにユーザーが含めるメッセージ。
dismissed_review[dismissal_commit_id]stringレビューが存在する場合にそれが無視されたコミットの一意識別子。

レビューの依頼

プルリクエストのレビューがリクエストされた。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

review_requested のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。requested_reviewer
review_requesterobjectレビューを要求したユーザー。

レビューリクエストが削除されました

プルリクエストのレビューリクエストが削除されました。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

review_request_removed のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。requested_reviewer
review_requesterobjectレビューを要求したユーザー。

確認済み

プルリクエストがレビューされた。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
Pull Request

reviewed のプロパティ

このイベント プロパティは、Issue イベント オブジェクトの共通プロパティと同じ構造を使用しません。 このイベントに対しては、以下の属性が返されます。

名前タイプ説明
idintegerイベントのユニーク識別子。
node_idstringイベントのグローバル ノード ID
userobjectこの Issue についてコメントしたユーザ。
bodystringレビューの概要テキスト。
commit_idstringレビュー時のプルリクエストの最新コミットの SHA。
submitted_atstringレビューの送信日時を示すタイムスタンプ。
statestringサブミットされたレビューの状態。
          `commented`、`changes_requested`、`approved`、`dismissed` のいずれかになります。

html_url | string | レビューの HTML URL。 pull_request_url | string | プルリクエストを取得する REST API URL。 author_association | string | Issue のリポジトリでユーザが保持している権限。 たとえば、リポジトリの所有者がコメントを作成した場合は、値は "OWNER" です。 _links | object | html_urlpull_request_urlevent | string | イベントの値は "reviewed" です。

購読済み

誰かが Issue またはプルリクエストの通知を受け取るために登録した。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

subscribed のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

転送された

Issue が別のリポジトリに転送された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題

transferred のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

未割り当て

ユーザが Issue から割り当て解除された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

unassigned のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。
assigneeobjectこの Issue から割り当て解除されたユーザー。
          `assigner`
           | 
          `object` | この issue からの割り当て解除を実行したユーザー。 このフィールドは、issue イベントに関する REST API では使用できますが、タイムライン イベントに関する REST API では使用できません。

ラベルなし

Issue からラベルが削除された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

ラベルなしのプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。label
label[color]string16 進数カラー コード。

解除された

Issue がロック解除された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

解錠状態のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。
lock_reasonstringIssue または pull request の会話がロックされた理由 (指定されている場合)。

unmarked_as_duplicate

ユーザが以前に別の Issue の複製としてマークした Issue が重複と見なされなくなった。または、ユーザが以前に別のプルリクエストの複製としてマークしたプルリクエストが重複と見なされなくなった。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

unmarked_as_duplicate のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

unpinned

Issue がピン留め解除された。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題

ピン留め解除状態のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。

登録解除

誰かが課題またはプルリクエストの通知を受信しないように登録を解除した。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

unsubscribed のプロパティ

データ 再利用可能.問題イベント.共通プロパティ %}

ユーザーがブロックされました

Organization のオーナーがユーザを Organization からブロックした。 これは、Issue でブロックされたユーザーのコメントの 1 つを通じて行われました。

このイベントは、次の issue の種類で使用できます。

課題イベントのためのREST APIタイムライン イベント用の REST API
課題
Pull Request

user_blocked のプロパティ

名前Type説明
idintegerイベントの一意識別子。
node_idstringイベントのグローバル ノード ID
urlstringイベントをフェッチするためのREST API URL。
actorobjectイベントを生成したユーザ。
eventstring発生したイベントの実際の種類を特定します。
commit_idstringこのIssueを参照するコミットのSHA。
commit_urlstringこのIssueを参照するコミットへのGitHub REST APIリンク。
created_atstringイベントが発生した時刻を示すタイムスタンプ。