Issue event types

Issue events are triggered by activity in issues and pull requests and are available in the Issue Events API and the Timeline Events API. Each event type specifies whether the event is available in the Issue Events or Timeline Events APIs.

GitHub's REST API considers every pull request to be an issue, but not every issue is a pull request. For this reason, the Issue Events and Timeline Events endpoints may return both issues and pull requests in the response. Pull requests have a pull_request property in the issue object. Because pull requests are issues, issue and pull request numbers do not overlap in a repository. For example, if you open your first issue in a repository, the number will be 1. If you then open a pull request, the number will be 2. Each event type specifies if the event occurs in pull request, issues, or both.

Issue event object common properties

Issue events all have the same object structure, except events that are only available in the Timeline Events API. Some events also include additional properties that provide more context about the event resources. Refer to the specific event to for details about any properties that differ from this object format.

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

added_to_project

The issue or pull request was added to a project board. このイベントは、リポジトリでプロジェクトボードが有効になっている場合の応答でのみ表示されます。

Availability

Issue type	Issue events API	Timeline events API
Issues Pull request	X	X

Event object properties

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

project_card 属性を受け取るには、リポジトリに対してプロジェクトボードを有効にする必要があります。また、Accept ヘッダーでカスタムメディアの種類を指定する必要があります。

application/vnd.github.starfox-preview+json

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

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`project_card`	`object`	プロジェクトカードオブジェクト。
`project_id`	`integer`	プロジェクトカードの一意識別子。
`project_url`	`string`	プロジェクトカードを取得する REST API URL。
`column_name`	`string`	Issue がある列の名前。

assigned

The issue or pull request was assigned to a user.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`assignee`	`object`	この issue から割り当て解除されたユーザー。
`assigner`	`object`	この issue からの割り当て解除を実行したユーザー。

automatic_base_change_failed

GitHub unsuccessfully attempted to automatically change the base branch of the pull request.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

automatic_base_change_succeeded

GitHub successfully attempted to automatically change the base branch of the pull request.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

base_ref_changed

The base reference branch of the pull request changed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

closed

The issue or pull request was closed. When the commit_id is present, it identifies the commit that closed the issue using "closes / fixes" syntax. For more information about the syntax, see "Linking a pull request to an issue".

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

commented

A comment was added to the issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests		X

Event object properties

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

Name	Type	Description
`url`	`string`	The REST API URL to retrieve the issue comment.
`html_url`	`string`	The HTML URL of the issue comment.
`issue_url`	`string`	The HTML URL of the issue.
`id`	`integer`	The unique identifier of the event.
`node_id`	`string`	The Global Node ID of the event.
`user`	`object`	The person who commented on the issue.
`created_at`	`string`	The timestamp indicating when the comment was added.
`updated_at`	`string`	The timestamp indicating when the comment was updated or created, if the comment is never updated.
`author_association`	`string`	The permissions the user has in the issue's repository. For example, the value would be `"OWNER"` if the owner of repository created a comment.
`body`	`string`	The comment body text.
`event`	`string`	The event value is `"commented"`.
`actor`	`object`	The person who generated the event.

committed

A commit was added to the pull request's HEAD branch.

Availability

Issue type	Issue events API	Timeline events API
Pull requests		X

Event object properties

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

Name	Type	Description
`sha`	`string`	The SHA of the commit in the pull request.
`node_id`	`string`	The Global Node ID of the event.
`url`	`string`	The REST API URL to retrieve the commit.
`html_url`	`string`	The HTML URL of the commit.
`author`	`object`	The person who authored the commit.
`committer`	`object`	The person who committed the commit on behalf of the author.
`tree`	`object`	The Git tree of the commit.
`message`	`string`	The commit message.
`parents`	`array of objects`	A list of parent commits.
`verification`	`object`	The result of verifying the commit's signature. For more information, see "Signature verification object."
`event`	`string`	The event value is `"committed"`.

connected

The issue or pull request was linked to another issue or pull request. For more information, see "Linking a pull request to an issue".

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

convert_to_draft

The pull request was converted to draft mode.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

converted_note_to_issue

The issue was created by converting a note in a project board to an issue. このイベントは、リポジトリでプロジェクトボードが有効になっている場合の応答でのみ表示されます。

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

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

project_card 属性を受け取るには、リポジトリに対してプロジェクトボードを有効にする必要があります。また、Accept ヘッダーでカスタムメディアの種類を指定する必要があります。

application/vnd.github.starfox-preview+json

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

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`project_card`	`object`	プロジェクトカードオブジェクト。
`project_id`	`integer`	プロジェクトカードの一意識別子。
`project_url`	`string`	プロジェクトカードを取得する REST API URL。
`column_name`	`string`	Issue がある列の名前。

converted_to_discussion

The issue was closed and converted to a discussion.

Availability

Issue type	Issue events API	Timeline events API
Issues	X

Event Object Properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

cross-referenced

The issue or pull request was referenced from another issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests		X

Event object properties

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

Name	Type	Description
`actor`	`object`	The person who generated the event.
`created_at`	`string`	The timestamp indicating when the cross-reference was added.
`updated_at`	`string`	The timestamp indicating when the cross-reference was updated or created, if the cross-reference is never updated.
`source`	`object`	The issue or pull request that added a cross-reference.
`source[type]`	`string`	This value will always be `"issue"` because pull requests are of type issue. Only cross-reference events triggered by issues or pull requests are returned in the Timeline Events API. To determine if the issue that triggered the event is a pull request, you can check if the `source[issue][pull_request]` object exists.
`source[issue]`	`object`	The `issue` object that added the cross-reference.
`event`	`string`	The event value is `"cross-referenced"`.

demilestoned

The issue or pull request was removed from a milestone.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`milestone`	`object`	The milestone object.
`milestone[title]`	`string`	The title of the milestone.

deployed

The pull request was deployed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

deployment_environment_changed

The pull request deployment environment was changed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

disconnected

The issue or pull request was unlinked from another issue or pull request. For more information, see "Linking a pull request to an issue".

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

head_ref_deleted

The pull request's HEAD branch was deleted.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

head_ref_restored

The pull request's HEAD branch was restored to the last known commit.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

head_ref_force_pushed

The pull request's HEAD branch was force pushed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

labeled

A label was added to the issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`label`	`object`	この issue から削除されたラベル `label[name]`
`label[color]`	`string`	16 進数カラーコード。

locked

The issue or pull request was locked.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`lock_reason`	`string`	The reason an issue or pull request conversation was locked, if one was provided.

mentioned

The actor was @mentioned in an issue or pull request body.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

marked_as_duplicate

A user with write permissions marked an issue as a duplicate of another issue, or a pull request as a duplicate of another pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

merged

The pull request was merged. The commit_id attribute is the SHA1 of the HEAD commit that was merged. The commit_repository is always the same as the main repository.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

milestoned

The issue or pull request was added to a milestone.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`milestone`	`object`	The milestone object.
`milestone[title]`	`string`	The title of the milestone.

moved_columns_in_project

The issue or pull request was moved between columns in a project board. このイベントは、リポジトリでプロジェクトボードが有効になっている場合の応答でのみ表示されます。

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

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

project_card 属性を受け取るには、リポジトリに対してプロジェクトボードを有効にする必要があります。また、Accept ヘッダーでカスタムメディアの種類を指定する必要があります。

application/vnd.github.starfox-preview+json

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

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`project_card`	`object`	プロジェクトカードオブジェクト。
`project_id`	`integer`	プロジェクトカードの一意識別子。
`project_url`	`string`	プロジェクトカードを取得する REST API URL。
`column_name`	`string`	Issue がある列の名前。
`previous_column_name`	`string`	The name of the column the issue was moved from.

pinned

The issue was pinned.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

ready_for_review

A draft pull request was marked as ready for review.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

referenced

The issue was referenced from a commit message. The commit_id attribute is the commit SHA1 of where that happened and the commit_repository is where that commit was pushed.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

removed_from_project

The issue or pull request was removed from a project board. このイベントは、リポジトリでプロジェクトボードが有効になっている場合の応答でのみ表示されます。

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

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

project_card 属性を受け取るには、リポジトリに対してプロジェクトボードを有効にする必要があります。また、Accept ヘッダーでカスタムメディアの種類を指定する必要があります。

application/vnd.github.starfox-preview+json

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

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`project_card`	`object`	プロジェクトカードオブジェクト。
`project_id`	`integer`	プロジェクトカードの一意識別子。
`project_url`	`string`	プロジェクトカードを取得する REST API URL。
`column_name`	`string`	Issue がある列の名前。

renamed

The issue or pull request title was changed.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`rename`	`object`	The name details.
`rename[from]`	`string`	The previous name.
`rename[to]`	`string`	The new name.

reopened

The issue or pull request was reopened.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

review_dismissed

The pull request review was dismissed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`dismissed_review`	`object`	却下されたレビューの情報。
`dismissed_review[state]`	`string`	pull request が無視されたときの状態。 `commented`、`approved`、または `changes_requested` のいずれかにすることができます。
`dismissed_review[review_id]`	`string`	pull request のレビューの一意の識別子。
`dismissed_review[dismissal_message]`	`string`	レビューを閉じるときにユーザーが含めるメッセージ。
`dismissed_review[dismissal_commit_id]`	`string`	レビューが存在する場合にそれが無視されたコミットの一意識別子。

review_requested

A pull request review was requested.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`requested_reviewer`	`object`	pull request を確認するように要求されたユーザー。
`review_requester`	`object`	レビューを要求したユーザー。

review_request_removed

A pull request review request was removed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`requested_reviewer`	`object`	pull request を確認するように要求されたユーザー。
`review_requester`	`object`	レビューを要求したユーザー。

reviewed

The pull request was reviewed.

Availability

Issue type	Issue events API	Timeline events API
Pull requests		X

Event object properties

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

Name	Type	Description
`id`	`integer`	The unique identifier of the event.
`node_id`	`string`	The Global Node ID of the event.
`user`	`object`	The person who commented on the issue.
`body`	`string`	The review summary text.
`commit_id`	`string`	The SHA of the latest commit in the pull request at the time of the review.
`submitted_at`	`string`	The timestamp indicating when the review was submitted.
`state`	`string`	The state of the submitted review. Can be one of: `commented`, `changes_requested`, or `approved`.
`html_url`	`string`	The HTML URL of the review.
`pull_request_url`	`string`	The REST API URL to retrieve the pull request.
`author_association`	`string`	The permissions the user has in the issue's repository. For example, the value would be `"OWNER"` if the owner of repository created a comment.
`_links`	`object`	The `html_url` and `pull_request_url`.
`event`	`string`	The event value is `"reviewed"`.

subscribed

Someone subscribed to receive notifications for an issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

transferred

The issue was transferred to another repository.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

unassigned

A user was unassigned from the issue.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`assignee`	`object`	この issue から割り当て解除されたユーザー。
`assigner`	`object`	この issue からの割り当て解除を実行したユーザー。

unlabeled

A label was removed from the issue.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`label`	`object`	この issue から削除されたラベル `label[name]`
`label[color]`	`string`	16 進数カラーコード。

unlocked

The issue was unlocked.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。
`lock_reason`	`string`	The reason an issue or pull request conversation was locked, if one was provided.

unmarked_as_duplicate

An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate, or a pull request that a user had previously marked as a duplicate of another pull request is no longer considered a duplicate.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

unpinned

The issue was unpinned.

Availability

Issue type	Issue events API	Timeline events API
Issues	X	X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

unsubscribed

Someone unsubscribed from receiving notifications for an issue or pull request.

Availability

Issue type	Issue events API	Timeline events API
Issues Pull requests		X

Event object properties

名前	型	説明
`id`	`integer`	イベントの一意識別子。
`node_id`	`string`	イベントのグローバルノード ID。
`url`	`string`	イベントをフェッチするためのREST API URL。
`actor`	`object`	イベントを生成したユーザ。
`event`	`string`	発生したイベントの実際の種類を特定します。
`commit_id`	`string`	このIssueを参照するコミットのSHA。
`commit_url`	`string`	このIssueを参照するコミットへのGitHub REST APIリンク。
`created_at`	`string`	イベントが発生した時刻を示すタイムスタンプ。

Issue event types

In this article

Issue event object common properties

added_to_project

Availability

Event object properties

assigned

Availability

Event object properties

automatic_base_change_failed

Availability

Event object properties

automatic_base_change_succeeded

Availability

Event object properties

base_ref_changed

Availability

Event object properties

closed

Availability

Event object properties

commented

Availability

Event object properties

committed

Availability

Event object properties

connected

Availability

Event object properties

convert_to_draft

Availability

Event object properties

converted_note_to_issue

Availability

Event object properties

converted_to_discussion

Availability

Event Object Properties

cross-referenced

Availability

Event object properties

demilestoned

Availability

Event object properties

deployed

Availability

Event object properties

deployment_environment_changed

Availability

Event object properties

disconnected

Availability

Event object properties

head_ref_deleted

Availability

Event object properties

head_ref_restored

Availability

head_ref_force_pushed

Availability

Event object properties

labeled

Availability

Event object properties

locked

Availability

Event object properties

mentioned

Availability

Event object properties

marked_as_duplicate

Availability

Event object properties

merged

Availability

Event object properties

milestoned

Availability

Event object properties