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

Issue イベントタイプ

Issues イベント API とタイムライン API について、各イベントタイプ、GitHub でのトリガーアクション、および各イベントの一意のプロパティについて学びます。

Issue イベントは、Issue およびプルリクエストのアクティビティによってトリガーされ、Issue イベント API およびタイムラインイベント API で使用できます。 各イベントタイプでは、イベントが Issue イベントやタイムラインイベント API で使用可能かどうかを指定します。

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

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

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

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

added_to_project

Issue またはプルリクエストがプロジェクトボードに追加された。 プロジェクトボードがリポジトリで有効化されている場合にのみ、レスポンス中にこのイベントが示されます。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

ノート: プロジェクトカードの詳細は、プロジェクト関連のissue及びタイムラインイベントのREST APIレスポンス中に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細についてはブログポストを参照してください。

project_card 属性を受け取るには、リポジトリでプロジェクトボードが有効化されていなければならず、カスタムのメディアタイプAcceptヘッダで提供しなければなりません。

application/vnd.github.starfox-preview+json

警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。

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

アサイン

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

名前種類説明
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

automatic_base_change_failed

GitHub がプルリクエストのベースブランチを自動的に変更しようとしたが失敗した。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
X

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

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

automatic_base_change_succeeded

GitHub がプルリクエストのベースブランチを自動的に変更しようとした。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
X

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

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

base_ref_changed

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
X

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

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

closed

Issue またはプルリクエストがクローズされた。 commit_id が存在する場合、「closes / fixes」構文を使用して Issue をクローズしたコミットを識別します。 構文に関する詳しい情報については「プルリクエストを Issue にリンクする」を参照してください。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

名前種類説明
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 イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
X

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

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

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

committed

プルリクエストの HEAD ブランチにコミットが追加された。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
X

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

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

名前種類説明
shastringプルリクエスト内のコミットの SHA。
node_idstringイベントのグローバルノード ID
urlstringコミットを取得する REST API URL。
html_urlstringコミットの HTML URL。
作者オブジェクトコミットの作者。
コミッターオブジェクト作者に代わってコミットしたユーザ。
ツリーオブジェクトコミットの Git ツリー。
messagestringコミットメッセージ。
array of objects親コミットのリスト。
検証オブジェクトコミットの署名の検証結果。 詳しい情報については、「署名検証オブジェクト」を参照してください。
eventstringイベントの値は "committed" です。

connected

Issue またはプルリクエストが、別の Issue またはプルリクエストにリンクされた。 詳しい情報については「プルリクエストを Issue にリンクする」を参照してください。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

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

convert_to_draft

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
XX

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

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

converted_note_to_issue

Issue がプロジェクトボードのメモを Issue に変換して作成された。 プロジェクトボードがリポジトリで有効化されている場合にのみ、レスポンス中にこのイベントが示されます。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
XX

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

ノート: プロジェクトカードの詳細は、プロジェクト関連のissue及びタイムラインイベントのREST APIレスポンス中に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細についてはブログポストを参照してください。

project_card 属性を受け取るには、リポジトリでプロジェクトボードが有効化されていなければならず、カスタムのメディアタイプAcceptヘッダで提供しなければなりません。

application/vnd.github.starfox-preview+json

警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。

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

cross-referenced

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
X

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

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

名前種類説明
actorオブジェクトイベントを生成したユーザ。
created_atstringクロスリファレンスの追加日時を示すタイムスタンプ。
updated_atstringクロスリファレンスが更新されていない場合、クロスリファレンスの更新または作成時期を示すタイムスタンプ。
資料オブジェクトクロスリファレンスを追加した Issue またはプルリクエスト。
source[type]stringプルリクエストは Issue タイプのため、この値は常に "issue" になります。 タイムラインイベント API では、Issue またはプルリクエストによってトリガーされたクロスリファレンスイベントのみが返されます。 イベントをトリガーした Issue がプルリクエストかどうかを判断するには、source[issue][pull_request オブジェクトの有無を確認します。
source[issue]オブジェクトクロスリファレンスを追加した issue オブジェクト。
eventstringイベントの値は "cross-referenced" です。

demilestoned

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

名前種類説明
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]

deployed

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
XX

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

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

deployment_environment_changed

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
X

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

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

disconnected

Issue またはプルリクエストが、別の Issue またはプルリクエストからリンク解除された。 詳しい情報については「プルリクエストを Issue にリンクする」を参照してください。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

名前種類説明
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

プルリクエストの HEAD ブランチが削除された。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
XX

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

名前種類説明
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

プルリクエストの HEAD ブランチが最後の既知のコミットに復元された。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
XX

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

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

labeled

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

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

locked

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

ノート: Issueをロックする際に理由を追加するREST APIを利用できるようになりました。ロックの理由は、IssueやPull Requestを含むレスポンス中で見ることができます。 ロックの理由は、lockedイベント中でも見ることができます。 この機能は現在プレビューとして開発者が利用できます。 完全な詳細についてはブログポストを参照してください。 この機能にアクセスするには、カスタムのメディアタイプAcceptヘッダで渡さなければなりません。

application/vnd.github.sailor-v-preview+json

警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。

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

メンション

actor が Issue またはプルリクエストの本文で @mentioned された。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

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

marked_as_duplicate

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

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

merged

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
X

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

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

milestoned

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

名前種類説明
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]

moved_columns_in_project

Issue またはプルリクエストがプロジェクトボードの列間で移動された。 プロジェクトボードがリポジトリで有効化されている場合にのみ、レスポンス中にこのイベントが示されます。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

ノート: プロジェクトカードの詳細は、プロジェクト関連のissue及びタイムラインイベントのREST APIレスポンス中に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細についてはブログポストを参照してください。

project_card 属性を受け取るには、リポジトリでプロジェクトボードが有効化されていなければならず、カスタムのメディアタイプAcceptヘッダで提供しなければなりません。

application/vnd.github.starfox-preview+json

警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。

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

ピン止め済み

Issue がピン留めされた。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
XX

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

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

ready_for_review

ドラフトモードではないプルリクエストが作成された。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
XX

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

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

referenced

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

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

removed_from_project

Issue またはプルリクエストがプロジェクトボードから削除された。 プロジェクトボードがリポジトリで有効化されている場合にのみ、レスポンス中にこのイベントが示されます。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

ノート: プロジェクトカードの詳細は、プロジェクト関連のissue及びタイムラインイベントのREST APIレスポンス中に示されるようになりました。 この機能は、プレビューとして開発者が利用できるようになりました。 詳細についてはブログポストを参照してください。

project_card 属性を受け取るには、リポジトリでプロジェクトボードが有効化されていなければならず、カスタムのメディアタイプAcceptヘッダで提供しなければなりません。

application/vnd.github.starfox-preview+json

警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。

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

renamed

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

名前種類説明
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]

reopened

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

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

review_dismissed

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
XX

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

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

review_requested

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
XX

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

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

review_request_removed

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
XX

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

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

reviewed

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • プルリクエスト
X

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

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

名前種類説明
idintegerイベントの一意の識別子。
node_idstringイベントのグローバルノード ID
ユーザオブジェクトこの Issue についてコメントしたユーザ。
bodystringレビューの概要テキスト。
commit_idstringレビュー時のプルリクエストの最新コミットの SHA。
submitted_atstringレビューの送信日時を示すタイムスタンプ。
statestringサブミットされたレビューの状態。 commentedchanges_requestedapproved のいずれかになります。
html_urlstringレビューの HTML URL。
pull_request_urlstringプルリクエストを取得する REST API URL。
author_associationstringIssue のリポジトリでユーザが保持している権限。 たとえば、リポジトリの所有者がコメントを作成した場合、値は「OWNER」になります。
_linksオブジェクトhtml_url および pull_request_url
eventstringイベントの値は "reviewed" です。

subscribed

誰かが Issue またはプルリクエストの通知を受信するようにサブスクライブした。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

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

transferred

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
XX

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

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

unassigned

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

名前種類説明
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

unlabeled

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

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

unlocked

Issue がロック解除された。

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

ノート: Issueをロックする際に理由を追加するREST APIを利用できるようになりました。ロックの理由は、IssueやPull Requestを含むレスポンス中で見ることができます。 ロックの理由は、lockedイベント中でも見ることができます。 この機能は現在プレビューとして開発者が利用できます。 完全な詳細についてはブログポストを参照してください。 この機能にアクセスするには、カスタムのメディアタイプAcceptヘッダで渡さなければなりません。

application/vnd.github.sailor-v-preview+json

警告: このAPIは、プレビュー期間に予告なく変更されることがあります。 プレビューの機能は、実稼働環境での利用はサポートされていません。 問題があった場合には、サイト管理者にお問い合わせください。

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

unmarked_as_duplicate

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

利用の可否

Issue タイプIssue イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
XX

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

名前種類説明
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 タイプIssue イベント APIタイムラインイベント API
  • 問題
XX

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

名前種類説明
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 イベント APIタイムラインイベント API
  • 問題
  • プルリクエスト
X

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

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

問題がまだ解決していませんか?

GitHubコミュニティで質問するサポートへの連絡