Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。

Webhook のイベントとペイロード

各 Webhook イベントが発生するタイミングと、そのペイロードに含まれる内容について説明します。

Enterprise アカウントは、GitHub Enterprise Cloud、および GitHub Enterprise Server で利用できます。 詳細については、GitHub Enterprise Cloud ドキュメントの "Enterprise アカウントについて."

Enterprise アカウント、または Enterprise アカウントの一部である Organization で構成された Webhook には、enterprise アカウント オブジェクトが含まれます。

webhookを設定する際には、ペイロードを送信するイベントを選択するためにUIもしくはAPIが使用できます。 処理する計画の特定のイベントだけをサブスクライブすることによってのみ、サーバーへのHTTPリクエスト数を制限できます。 現在、そして未来のすべてのイベントをサブスクライブすることもできます。 デフォルトでは、webhookはプッシュイベントだけをサブスクライブします。 サブスクライブするイベントのリストは、いつでも変更できます。

このページに表示されているイベントをサブスクライブする webhook を作成できます。 各 webhook イベントには、webhook プロパティの説明とペイロードの例が含まれています。 詳しくは、「webhookの作成」を参照してください。

webhook ペイロードオブジェクトの共通プロパティ

各 webhook イベントペイロードには、イベント固有のプロパティも含まれています。 固有のプロパティは、個々のイベントタイプのセクションにあります。

キー種類説明
actionstringほとんどの webhook ペイロードには、イベントをトリガーした特定のアクティビティを含む action プロパティが含まれています。
senderobjectイベントをトリガーしたユーザー。 このプロパティは、すべての webhook ペイロードに含まれています。
repositoryobjectイベントが発生した repository。 イベントがリポジトリ内のアクティビティから発生した場合、webhook ペイロードには repository プロパティが含まれます。
organizationobjectWebhook ペイロードには、Webhook が組織用に構成されている場合、または組織が所有するリポジトリ内のアクティビティからイベントが発生した場合に、organization オブジェクトが含まれます。 installation

webhook イベントの一意のプロパティは、Events API の使用時に payload プロパティに含まれるプロパティと同じです。 例外の 1 つは push イベントです。 push イベントの webhook ペイロードの一意のプロパティと Events API の payload プロパティは異なります。 webhook ペイロードには、より詳細な情報が含まれています。

注: ペイロードの上限は 25 MB です。 イベントにより大きなペイロードが生成された場合、webhook は起動しません。 これは、たとえば、多数のブランチまたはタグが一度にプッシュされた場合に、create イベントで発生する可能性があります。 確実にデリバリが行われるよう、ペイロードサイズを監視することをお勧めします。

デリバリヘッダ

Webhook の構成済み URL エンドポイントにデリバリーされる HTTP POST ペイロードには、いくつかの特別なヘッダーが含まれています。

  • X-GitHub-Event: デリバリーをトリガーしたイベントの名前。
  • X-GitHub-Delivery: デリバリーを識別するための GUID
  • X-Hub-Signature: このヘッダーは、Webhook が secret で構成されている場合に送信されます。 これは要求本文の HMAC 16 進ダイジェストであり、SHA-1 ハッシュ関数と secret (HMAC key として) を使用して生成されます。X-Hub-Signature は、既存の統合との互換性のために提供されており、代わりにより安全な X-Hub-Signature-256 を使用することをお勧めします。
  • X-Hub-Signature-256: このヘッダーは、Webhook が secret で構成されている場合に送信されます。 これは要求本文の HMAC 16 進ダイジェストであり、SHA-256 ハッシュ関数と secret (HMAC key として) を使用して生成されます。

また、要求の User-Agent にはプレフィックス GitHub-Hookshot/ も含まれます。

デリバリの例

> POST /payload HTTP/2

> Host: localhost:4567
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c
> User-Agent: GitHub-Hookshot/044aadd
> Content-Type: application/json
> Content-Length: 6615
> X-GitHub-Event: issues

> {
>   "action": "opened",
>   "issue": {
>     "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
>     "number": 1347,
>     ...
>   },
>   "repository" : {
>     "id": 1296269,
>     "full_name": "octocat/Hello-World",
>     "owner": {
>       "login": "octocat",
>       "id": 1,
>       ...
>     },
>     ...
>   },
>   "sender": {
>     "login": "octocat",
>     "id": 1,
>     ...
>   }
> }

branch_protection_rule

This event occurs when there is activity relating to branch protection rules. For more information, see "About protected branches." For information about the APIs to manage branch protection rules, see the GraphQL documentation or "Branch protection" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission

branch_protection_rule の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

branch_protection_rule の Webhook ペイロード オブジェクト

A branch protection rule was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

rule object 必須

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

sender object 必須

A GitHub user.

check_run

This event occurs when there is activity relating to a check run. For information about check runs, see "Getting started with the Checks API." For information about the APIs to manage check runs, see the GraphQL API documentation or "Check Runs" in the REST API documentation.

For activity relating to check suites, use the check-suite event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

check_run の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

check_run の Webhook ペイロード オブジェクト

A check run was completed, and a conclusion is available.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string

: completed

check_run object 必須

A check performed on the code of a given code change

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

check_suite

This event occurs when there is activity relating to a check suite. For information about check suites, see "Getting started with the Checks API." For information about the APIs to manage check suites, see the GraphQL API documentation or "Check Suites" in the REST API documentation.

For activity relating to check runs, use the check_run event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.

Repository and organization webhooks only receive payloads for the completed event types in repositories.

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

check_suite の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

check_suite の Webhook ペイロード オブジェクト

All check runs in a check suite have completed, and a conclusion is available.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: completed

actions_meta object or null
check_suite object 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

code_scanning_alert

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "About code scanning" and "About code scanning alerts." For information about the API to manage code scanning, see "Code scanning" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.

code_scanning_alert の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

code_scanning_alert の Webhook ペイロード オブジェクト

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: appeared_in_branch

alert object 必須

The code scanning alert involved in the event.

commit_oid string 必須

The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

ref string 必須

The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

commit_comment

This event occurs when there is activity relating to commit comments. For more information about commit comments, see "Commenting on a pull request." For information about the APIs to manage commit comments, see the GraphQL API documentation or "Commit comments" in the REST API documentation.

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.

commit_comment の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

commit_comment の Webhook ペイロード オブジェクト

Someone commented on a commit.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

The action performed. Can be created.

: created

comment object 必須

The commit comment resource.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

create

This event occurs when a Git branch or tag is created.

To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.

Note: This event will not occur when more than three tags are created at once.

create の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

create の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
description string or null 必須

The repository's current description.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

master_branch string 必須

The name of the repository's default branch (usually main).

organization object

A GitHub organization.

pusher_type string 必須

The pusher type for the event. Can be either user or a deploy key.

ref string 必須

The git ref resource.

ref_type string 必須

The type of Git ref object created in the repository.

次のいずれかにできます: tag, branch

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

delete

This event occurs when a Git branch or tag is deleted.

To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.

Note: This event will not occur when more than three tags are deleted at once.

delete の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

delete の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pusher_type string 必須

The pusher type for the event. Can be either user or a deploy key.

ref string 必須

The git ref resource.

ref_type string 必須

The type of Git ref object deleted in the repository.

次のいずれかにできます: tag, branch

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

dependabot_alert

This event occurs when there is activity relating to Dependabot alerts.

For more information about Dependabot alerts, see "About Dependabot alerts." For information about the API to manage Dependabot alerts, see "Dependabot alerts" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

dependabot_alert の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

dependabot_alert の Webhook ペイロード オブジェクト

A Dependabot alert was automatically closed.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: auto_dismissed

alert object 必須

A Dependabot alert.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

enterprise object

An enterprise on GitHub.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

deploy_key

This event occurs when there is activity relating to deploy keys. For more information, see "Managing deploy keys." For information about the APIs to manage deploy keys, see the GraphQL API documentation or "Deploy keys" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.

deploy_key の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

deploy_key の Webhook ペイロード オブジェクト

A deploy key was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

key object 必須

The deploy key resource.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

deployment

This event occurs when there is activity relating to deployments. For more information, see "About deployments." For information about the APIs to manage deployments, see the GraphQL API documentation or "Deployments" in the REST API documentation.

For activity relating to deployment status, use the deployment_status event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.

deployment の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

deployment の Webhook ペイロード オブジェクト

A deployment was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

deployment object 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

workflow object or null 必須
workflow_run object or null 必須

deployment_protection_rule

This event occurs when there is activity relating to deployment protection rules. For more information, see "Using environments for deployment." For information about the API to manage deployment protection rules, see the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.

deployment_protection_rule の可用性

  • GitHub アプリ

deployment_protection_rule の Webhook ペイロード オブジェクト

A deployment protection rule was requested for an environment.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string

: requested

environment string

The name of the environment that has the deployment protection rule.

event string

The event that triggered the deployment protection rule.

deployment_callback_url string

The URL to review the deployment protection rule.

deployment object

A request for a specific ref(branch,sha,tag) to be deployed

pull_requests array of objects
repository object

A repository on GitHub.

organization object

A GitHub organization.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

sender object

A GitHub user.

deployment_status

This event occurs when there is activity relating to deployment statuses. For more information, see "About deployments." For information about the APIs to manage deployments, see the GraphQL API documentation or "Deployments" in the REST API documentation.

For activity relating to deployment creation, use the deployment event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.

deployment_status の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

deployment_status の Webhook ペイロード オブジェクト

A new deployment status was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

check_run object or null
deployment object 必須
deployment_status object 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

workflow object or null
workflow_run object or null

discussion

This event occurs when there is activity relating to a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.

For activity relating to a comment on a discussion, use the discussion_comment event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

discussion の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

discussion の Webhook ペイロード オブジェクト

A comment on the discussion was marked as the answer.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: answered

answer object 必須
discussion object 必須

A Discussion in a repository.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

discussion_comment

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

discussion_comment の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

discussion_comment の Webhook ペイロード オブジェクト

A comment on a discussion was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

comment object 必須
discussion object 必須

A Discussion in a repository.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

fork

This event occurs when someone forks a repository. For more information, see "Fork a repo." For information about the API to manage forks, see "Forks" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.

fork の可用性

  • Enterprise
  • リポジトリ
  • 組織
  • GitHub アプリ

fork の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
enterprise object

An enterprise on GitHub.

forkee object 必須

The created repository resource.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

github_app_authorization

This event occurs when a user revokes their authorization of a GitHub App. For more information, see "About apps." For information about the API to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see "Identifying and authorizing users for GitHub Apps."

github_app_authorization の可用性

  • GitHub アプリ

github_app_authorization の Webhook ペイロード オブジェクト

Someone revoked their authorization of a GitHub App.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: revoked

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

sender object 必須

A GitHub user.

gollum

This event occurs when someone creates or updates a wiki page. For more information, see "About wikis."

To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.

gollum の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

gollum の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pages array of objects 必須

The pages that were updated.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

installation

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.

installation の可用性

  • GitHub アプリ

installation の Webhook ペイロード オブジェクト

Someone installed a GitHub App on a user or organization account.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

enterprise object

An enterprise on GitHub.

installation object 必須

Installation

organization object

A GitHub organization.

repositories array of objects

An array of repository objects that the installation can access.

repository object

A repository on GitHub.

requester object or null
sender object 必須

A GitHub user.

installation_repositories

This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.

installation_repositories の可用性

  • GitHub アプリ

installation_repositories の Webhook ペイロード オブジェクト

A GitHub App installation was granted access to one or more repositories.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: added

enterprise object

An enterprise on GitHub.

installation object 必須

Installation

organization object

A GitHub organization.

repositories_added array of objects 必須

An array of repository objects, which were added to the installation.

repositories_removed array of objects 必須

An array of repository objects, which were removed from the installation.

repository object

A repository on GitHub.

repository_selection string 必須

Describe whether all repositories have been selected or there's a selection involved

次のいずれかにできます: all, selected

requester object or null 必須
sender object 必須

A GitHub user.

installation_target

This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.

installation_target の可用性

  • GitHub アプリ

installation_target の Webhook ペイロード オブジェクト

Somebody renamed the user or organization account that a GitHub App is installed on.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
account object 必須
action string 必須
changes object 必須
enterprise object

An enterprise on GitHub.

installation object 必須

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

sender object

A GitHub user.

target_type string 必須

issue_comment

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "About issues" and "About pull requests." For information about the APIs to manage issue comments, see the GraphQL documentation or "Issue comments" in the REST API documentation.

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see "Working with comments."

To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.

issue_comment の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

issue_comment の Webhook ペイロード オブジェクト

A comment on an issue or pull request was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

comment object 必須

The comment itself.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

issue object 必須

The issue the comment belongs to.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

issues

This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.

For activity relating to a comment on an issue, use the issue_comment event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.

issues の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

issues の Webhook ペイロード オブジェクト

An issue was assigned to a user.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

The action that was performed.

: assigned

assignee object or null
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

issue object 必須

The issue itself.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

label

This event occurs when there is activity relating to labels. For more information, see "Managing labels." For information about the APIs to manage labels, see the GraphQL documentation or "Labels" in the REST API documentation.

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.

label の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

label の Webhook ペイロード オブジェクト

A label was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

label object 必須
organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object

A GitHub user.

marketplace_purchase

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "GitHub Marketplace." For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or "GitHub Marketplace" in the REST API documentation.

marketplace_purchase の可用性

  • GitHub Marketplace

marketplace_purchase の Webhook ペイロード オブジェクト

Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: cancelled

effective_date string 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

marketplace_purchase object 必須
organization object

A GitHub organization.

previous_marketplace_purchase object
repository object

A repository on GitHub.

sender object 必須

A GitHub user.

member

This event occurs when there is activity relating to collaborators in a repository. For more information, see "Adding outside collaborators to repositories in your organization." For more information about the API to manage repository collaborators, see the GraphQL API documentation or "Collaborators" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.

member の可用性

  • Enterprise
  • リポジトリ
  • 組織
  • GitHub アプリ

member の Webhook ペイロード オブジェクト

A GitHub user accepted an invitation to a repository.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: added

changes object
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

member object or null 必須
organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

membership

This event occurs when there is activity relating to team membership. For more information, see "About teams." For more information about the APIs to manage team memberships, see the GraphQL API documentation or "Team members" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.

membership の可用性

  • 組織
  • Enterprise
  • GitHub アプリ

membership の Webhook ペイロード オブジェクト

An organization member was added to a team.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: added

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

member object or null 必須
organization object 必須

A GitHub organization.

repository object

A repository on GitHub.

scope string 必須

The scope of the membership. Currently, can only be team.

: team

sender object or null 必須
team object 必須

Groups of organization members that gives permissions on specified repositories.

merge_group

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "Managing a merge queue."

To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission.

Note: The pull request merge queue feature is currently in public beta and subject to change.

merge_group の可用性

  • GitHub アプリ

merge_group の Webhook ペイロード オブジェクト

Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.

When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: checks_requested

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

merge_group object 必須

A group of pull requests that the merge queue has grouped together to be merged.

organization object

A GitHub organization.

repository object

A repository on GitHub.

sender object

A GitHub user.

meta

This event occurs when there is activity relating to a webhook itself.

To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission.

meta の可用性

  • GitHub Marketplace
  • Enterprise
  • リポジトリ
  • 組織
  • GitHub アプリ

meta の Webhook ペイロード オブジェクト

The webhook was deleted.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: deleted

enterprise object

An enterprise on GitHub.

hook object 必須

The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.

hook_id integer 必須

The id of the modified webhook.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

sender object

A GitHub user.

milestone

This event occurs when there is activity relating to milestones. For more information, see "About milestones." For information about the APIs to manage milestones, see the GraphQL documentation or "Milestones" in the REST API documentation.

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.

milestone の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

milestone の Webhook ペイロード オブジェクト

A milestone was closed.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: closed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

milestone object 必須

A collection of related issues and pull requests.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

org_block

This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "Blocking a user from your organization." For information about the APIs to manage blocked users, see the GraphQL documentation or "Blocking users" in the REST API documentation.

If you want to receive an event when members are added or removed from an organization, use the organization event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission.

org_block の可用性

  • 組織
  • Enterprise
  • GitHub アプリ

org_block の Webhook ペイロード オブジェクト

A user was blocked from the organization.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: blocked

blocked_user object or null 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object 必須

A GitHub organization.

repository object

A repository on GitHub.

sender object 必須

A GitHub user.

organization

This event occurs when there is activity relating to an organization and its members. For more information, see "About organizations." For information about the APIs to manage organizations, see the GraphQL documentation or "Organizations" in the REST API documentation.

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.

organization の可用性

  • 組織
  • Enterprise
  • GitHub アプリ

organization の Webhook ペイロード オブジェクト

An organization was deleted.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: deleted

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

membership object

The membership between the user and the organization. Not present when the action is member_invited.

organization object 必須

A GitHub organization.

repository object

A repository on GitHub.

sender object 必須

A GitHub user.

package

This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or "Packages" in the REST API documentation.

To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.

package の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

package の Webhook ペイロード オブジェクト

A package was published to a registry.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: published

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

package object 必須

Information about the package.

repository object

A repository on GitHub.

sender object 必須

A GitHub user.

page_build

This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "Configuring a publishing source for your GitHub Pages site." For information about the API to manage GitHub Pages, see "Pages" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.

page_build の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

page_build の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
build object 必須
enterprise object

An enterprise on GitHub.

id integer 必須
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

personal_access_token_request

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "Creating a personal access token."

To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission.

Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.

personal_access_token_request の可用性

  • GitHub アプリ

personal_access_token_request の Webhook ペイロード オブジェクト

A fine-grained personal access token request was approved.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: approved

personal_access_token_request object 必須

Details of a Personal Access Token Request.

organization object 必須

A GitHub organization.

sender object 必須

A GitHub user.

installation object 必須

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

ping

This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.

ping の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ
  • Enterprise
  • GitHub Marketplace

ping の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
hook object

The webhook that is being pinged

hook_id integer

The ID of the webhook that triggered the ping.

organization object

A GitHub organization.

repository object

A repository on GitHub.

sender object

A GitHub user.

zen string

Random string of GitHub zen.

project_card

This event occurs when there is activity relating to a card on a classic project. For more information, see "About projects (classic)." For information about the API to manage classic projects, see the GraphQL API documentation or "Projects (classic)" in the REST API documentation.

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.

project_card の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

project_card の Webhook ペイロード オブジェクト

A note in a classic project was converted to an issue.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: converted

changes object 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

project_card object 必須
repository object

A repository on GitHub.

sender object 必須

A GitHub user.

project

This event occurs when there is activity relating to a classic project. For more information, see "About projects (classic)." For information about the API to manage classic projects, see the GraphQL API documentation or "Projects (classic)" in the REST API documentation.

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.

project の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

project の Webhook ペイロード オブジェクト

A classic project was closed.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: closed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

project object 必須
repository object

A repository on GitHub.

sender object 必須

A GitHub user.

project_column

This event occurs when there is activity relating to a column on a classic project. For more information, see "About projects (classic)." For information about the API to manage classic projects, see the GraphQL API documentation or "Projects (classic)" in the REST API documentation.

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.

project_column の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

project_column の Webhook ペイロード オブジェクト

A column was added to a classic project.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

project_column object 必須
repository object

A repository on GitHub.

sender object

A GitHub user.

projects_v2

This event occurs when there is activity relating to an organization-level project. For more information, see "About Projects." For information about the Projects API, see the GraphQL documentation.

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

projects_v2 の可用性

  • 組織

projects_v2 の Webhook ペイロード オブジェクト

A project in the organization was closed.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: closed

organization object 必須

A GitHub organization.

projects_v2 object 必須

A projects v2 project

sender object 必須

A GitHub user.

projects_v2_item

This event occurs when there is activity relating to an item on an organization-level project. For more information, see "About Projects." For information about the Projects API, see the GraphQL documentation.

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

projects_v2_item の可用性

  • 組織

projects_v2_item の Webhook ペイロード オブジェクト

An item on an organization project was archived. For more information, see "Archiving items from your project."

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: archived

changes object 必須
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object 必須

A GitHub organization.

projects_v2_item object 必須

An item belonging to a project

sender object 必須

A GitHub user.

public

This event occurs when repository visibility changes from private to public. For more information, see "Setting repository visibility."

To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.

public の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

public の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

pull_request

This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.

pull_request の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

pull_request の Webhook ペイロード オブジェクト

A pull request was assigned to a user.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: assigned

assignee object or null 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

number integer 必須

The pull request number.

organization object

A GitHub organization.

pull_request object 必須
repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

pull_request_review_comment

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "Commenting on a pull request." For information about the APIs to manage pull request review comments, see the GraphQL API documentation or "Pull request review comments" in the REST API documentation.

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.

pull_request_review_comment の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

pull_request_review_comment の Webhook ペイロード オブジェクト

A comment on a pull request diff was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

comment object 必須

The comment itself.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pull_request object 必須
repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

pull_request_review

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "About pull request reviews." For information about the APIs to manage pull request reviews, see the GraphQL API documentation or "Pull request reviews" in the REST API documentation.

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.

pull_request_review の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

pull_request_review の Webhook ペイロード オブジェクト

A review on a pull request was dismissed.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: dismissed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pull_request object 必須
repository object 必須

A repository on GitHub.

review object 必須

The review that was affected.

sender object 必須

A GitHub user.

pull_request_review_thread

This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "About pull request reviews." For information about the APIs to manage pull request review comment threads, see the GraphQL API documentation or "Pull request reviews" in the REST API documentation.

For activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.

pull_request_review_thread の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

pull_request_review_thread の Webhook ペイロード オブジェクト

A comment thread on a pull request was marked as resolved.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: resolved

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pull_request object 必須
repository object 必須

A repository on GitHub.

sender object

A GitHub user.

thread object 必須

push

This event occurs when a commit or tag is pushed.

To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.

Note: An event will not be created when more than three tags are pushed at once.

push の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

push の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
after string 必須

The SHA of the most recent commit on ref after the push.

base_ref string or null 必須
before string 必須

The SHA of the most recent commit on ref before the push.

commits array of objects 必須

An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.

compare string 必須

URL that shows the changes in this ref update, from the before commit to the after commit. For a newly created ref that is directly based on the default branch, this is the comparison between the head of the default branch and the after commit. Otherwise, this shows all commits until the after commit.

created boolean 必須

Whether this push created the ref.

deleted boolean 必須

Whether this push deleted the ref.

enterprise object

An enterprise on GitHub.

forced boolean 必須

Whether this push was a force push of the ref.

head_commit object or null 必須
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pusher object 必須

Metaproperties for Git author/committer information.

ref string 必須

The full git ref that was pushed. Example: refs/heads/main or refs/tags/v3.14.1.

repository object 必須

A git repository

sender object

A GitHub user.

registry_package

This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or "Packages" in the REST API documentation.

To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.

Note: GitHub recommends that you use the newer package event instead.

registry_package の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

registry_package の Webhook ペイロード オブジェクト

A package was published to a registry.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: published

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

registry_package object 必須
repository object

A repository on GitHub.

sender object 必須

A GitHub user.

release

This event occurs when there is activity relating to releases. For more information, see "About releases." For information about the APIs to manage releases, see the GraphQL API documentation or "Releases" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.

release の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

release の Webhook ペイロード オブジェクト

A draft was saved, or a release or pre-release was published without previously being saved as a draft.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

release object 必須

The release object.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

repository_advisory

This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "About GitHub Security Advisories for repositories."

To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission.

repository_advisory の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

repository_advisory の Webhook ペイロード オブジェクト

A repository security advisory was published.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: published

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

repository_advisory object 必須

A repository security advisory.

sender object

A GitHub user.

repository

This event occurs when there is activity relating to repositories. For more information, see "About repositories." For information about the APIs to manage repositories, see the GraphQL documentation or "Repositories" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.

repository の可用性

  • Enterprise
  • リポジトリ
  • 組織
  • GitHub アプリ

repository の Webhook ペイロード オブジェクト

A repository was archived.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: archived

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

repository_dispatch

This event occurs when a GitHub App sends a POST request to /repos/{owner}/{repo}/dispatches. For more information, see the REST API documentation for creating a repository dispatch event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.

repository_dispatch の可用性

  • GitHub アプリ

repository_dispatch の Webhook ペイロード オブジェクト

The event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須
branch string 必須
client_payload object or null 必須
enterprise object

An enterprise on GitHub.

installation object 必須

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

repository_import

This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see "Importing a repository with GitHub Importer." For more information about the API to manage imports, see the REST API documentation.

repository_import の可用性

  • リポジトリ
  • 組織

repository_import の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

status string 必須

次のいずれかにできます: success, cancelled, failure

repository_vulnerability_alert

This event occurs when there is activity relating to a security vulnerability alert in a repository.

Note: This event is deprecated. Use the dependabot_alert event instead.

repository_vulnerability_alert の可用性

  • リポジトリ
  • 組織

repository_vulnerability_alert の Webhook ペイロード オブジェクト

A repository vulnerability alert was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: create

alert object 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

secret_scanning_alert

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.

secret_scanning_alert の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

secret_scanning_alert の Webhook ペイロード オブジェクト

A secret scanning alert was created.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

alert object 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object

A GitHub user.

secret_scanning_alert_location

This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.

For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.

For activity relating to secret scanning alerts, use the secret_scanning_alert event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.

secret_scanning_alert_location の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

secret_scanning_alert_location の Webhook ペイロード オブジェクト

A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string

: created

alert object 必須
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

location object 必須
organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

security_advisory

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "About GitHub Security Advisories for repositories." For information about the API to manage security advisories, see the GraphQL documentation.

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "About Dependabot alerts."

security_advisory の可用性

  • GitHub アプリ

security_advisory の Webhook ペイロード オブジェクト

A security advisory was published to the GitHub community.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: published

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

security_advisory object 必須

The details of the security advisory, including summary, description, and severity.

sender object

A GitHub user.

security_and_analysis

This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "GitHub security features."

To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.

security_and_analysis の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

security_and_analysis の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
changes object 必須
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

Full Repository

sender object

A GitHub user.

sponsorship

This event occurs when there is activity relating to a sponsorship listing. For more information, see "About GitHub Sponsors." For information about the API to manage sponsors, see the GraphQL documentation.

You can only create a sponsorship webhook on GitHub.com. For more information, see "Configuring webhooks for events in your sponsored account."

sponsorship の可用性

  • スポンサー付きアカウント

sponsorship の Webhook ペイロード オブジェクト

A sponsorship was cancelled and the last billing cycle has ended.

This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: cancelled

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

sender object 必須

A GitHub user.

sponsorship object 必須

star

This event occurs when there is activity relating to repository stars. For more information about stars, see "Saving repositories with stars." For information about the APIs to manage stars, see the GraphQL documentation or "Starring" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.

star の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

star の Webhook ペイロード オブジェクト

Someone starred a repository.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

starred_at string or null 必須

The time the star was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Will be null for the deleted action.

status

This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see "About status checks." For information about the APIs to manage commit statuses, see the GraphQL documentation or "Statuses" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission.

status の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

status の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
avatar_url string or null
branches array of objects 必須

An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches.

commit object 必須
context string 必須
created_at string 必須
description string or null 必須

The optional human-readable description added to the status.

enterprise object

An enterprise on GitHub.

id integer 必須

The unique identifier of the status.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

name string 必須
organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

sha string 必須

The Commit SHA.

state string 必須

The new state. Can be pending, success, failure, or error.

次のいずれかにできます: pending, success, failure, error

target_url string or null 必須

The optional link added to the status.

updated_at string 必須

team_add

This event occurs when a team is added to a repository. For more information, see "Managing teams and people with access to your repository."

For activity relating to teams, see the teams event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.

team_add の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

team_add の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

team object 必須

Groups of organization members that gives permissions on specified repositories.

team

This event occurs when there is activity relating to teams in an organization. For more information, see "About teams."

To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.

team の可用性

  • 組織
  • Enterprise
  • GitHub アプリ

team の Webhook ペイロード オブジェクト

A team was granted access to a repository.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: added_to_repository

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object 必須

A GitHub organization.

repository object

A git repository

sender object

A GitHub user.

team object 必須

Groups of organization members that gives permissions on specified repositories.

watch

This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "Managing your subscriptions." For information about the APIs to manage watching, see "Watching" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.

watch の可用性

  • リポジトリ
  • 組織
  • GitHub アプリ

watch の Webhook ペイロード オブジェクト

Someone started watching the repository.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: started

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

workflow_dispatch

This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "Manually running a workflow."

For activity relating to workflow runs, use the workflow_run event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.

workflow_dispatch の可用性

  • GitHub アプリ

workflow_dispatch の Webhook ペイロード オブジェクト

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
enterprise object

An enterprise on GitHub.

inputs object or null 必須
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

ref string 必須
repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

workflow string 必須

workflow_job

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "Using jobs in a workflow." For information about the API to manage workflow jobs, see "Workflow jobs" in the REST API documentation.

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.

workflow_job の可用性

  • Enterprise
  • リポジトリ
  • 組織
  • GitHub アプリ

workflow_job の Webhook ペイロード オブジェクト

A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: completed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

workflow_job object 必須
deployment object

A request for a specific ref(branch,sha,tag) to be deployed

workflow_run

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "About workflows." For information about the APIs to manage workflow runs, see the GraphQL documentation or "Workflow runs" in the REST API documentation.

For activity relating to a job in a workflow run, use the workflow_job event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.

workflow_run の可用性

  • Enterprise
  • リポジトリ
  • 組織
  • GitHub アプリ

workflow_run の Webhook ペイロード オブジェクト

A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.

ヘッダー
名前, Type, 説明
本文のパラメーター
名前, Type, 説明
action string 必須

: completed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object 必須

A repository on GitHub.

sender object 必須

A GitHub user.

workflow object or null 必須
workflow_run object 必須