Skip to main content

Webhook events and payloads

Learn about when each webhook event occurs and what the payload contains.

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

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

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

You can create webhooks that subscribe to the events listed on this page. Each webhook event includes a description of the webhook properties and an example payload. For more information, see "Creating webhooks."

Webhook payload object common properties

Each webhook event payload also contains properties unique to the event. You can find the unique properties in the individual event type sections.

KeyTypeDescription
actionstringMost webhook payloads contain an action property that contains the specific activity that triggered the event.
senderobjectイベントをトリガーしたユーザー。 This property is included in every webhook payload.
repositoryobjectイベントが発生した repository。 Webhook payloads contain the repository property when the event occurs from activity in a repository.
organizationobjectWebhook ペイロードには、Webhook が組織用に構成されている場合、または組織が所有するリポジトリ内のアクティビティからイベントが発生した場合に、organization オブジェクトが含まれます。
installationobjectGitHub App のインストール。 イベントが GitHub App 用に設定され、送信される場合、Webhook のペイロードには installation プロパティが含まれます。 For more information, see "Building GitHub App."

The unique properties for a webhook event are the same properties you'll find in the payload property when using the Events API. One exception is the push event. The unique properties of the push event webhook payload and the payload property in the Events API differ. The webhook payload contains more detailed information.

Note: Payloads are capped at 25 MB. If your event generates a larger payload, a webhook will not be fired. This may happen, for example, on a create event if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.

Delivery headers

HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers:

HeaderDescription
X-GitHub-EventName of the event that triggered the delivery.
X-GitHub-DeliveryA GUID to identify the delivery.
X-Hub-SignatureThis header is sent if the webhook is configured with a secret. This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the secret as the HMAC key. X-Hub-Signature is provided for compatibility with existing integrations, and we recommend that you use the more secure X-Hub-Signature-256 instead.
X-Hub-Signature-256This header is sent if the webhook is configured with a secret. This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the secret as the HMAC key.

Also, the User-Agent for the requests will have the prefix GitHub-Hookshot/.

Example delivery

> 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

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A branch protection rule was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

ruleobjectRequired

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.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstring

Value: completed

check_runobjectRequired

A check performed on the code of a given code change

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: completed

actions_metaobject or null
check_suiteobjectRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

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.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: appeared_in_branch

alertobjectRequired

The code scanning alert involved in the event.

commit_oidstringRequired

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.

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

refstringRequired

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.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Someone commented on a commit.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

The action performed. Can be created.

Value: created

commentobjectRequired

The commit comment resource.

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
descriptionstring or nullRequired

The repository's current description.

enterpriseobject

An enterprise on GitHub.

installationobject

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

master_branchstringRequired

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

organizationobject

A GitHub organization.

pusher_typestringRequired

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

refstringRequired

The git ref resource.

ref_typestringRequired

The type of Git ref object created in the repository.

Can be one of: tag, branch

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

pusher_typestringRequired

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

refstringRequired

The git ref resource.

ref_typestringRequired

The type of Git ref object deleted in the repository.

Can be one of: tag, branch

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

alertobjectRequired

A Dependabot alert.

installationobject

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

organizationobject

A GitHub organization.

enterpriseobject

An enterprise on GitHub.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A deploy key was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

enterpriseobject

An enterprise on GitHub.

installationobject

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

keyobjectRequired

The deploy key resource.

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

A deployment was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

deploymentobjectRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

workflowobject or nullRequired
workflow_runobject or nullRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

A new deployment status was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

check_runobject or null
deploymentobjectRequired
deployment_statusobjectRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

workflowobject or null
workflow_runobject 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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A comment on the discussion was marked as the answer.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: answered

answerobjectRequired
discussionRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A comment on a discussion was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

commentobjectRequired
discussionobjectRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Enterprises
  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
enterpriseobject

An enterprise on GitHub.

forkeeRequired

The created repository resource.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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."

Availability

  • GitHub Apps

Webhook payload object

Someone revoked their authorization of a GitHub App.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: revoked

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

pagesarray of objectsRequired

The pages that were updated.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

installation

This event occurs when there is activity relating to a GitHub App installation. 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.

Availability

  • GitHub Apps

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

enterpriseobject

An enterprise on GitHub.

installationobjectRequired

Installation

organizationobject

A GitHub organization.

repositoriesarray of objects

An array of repository objects that the installation can access.

repositoryobject

A repository on GitHub.

requesterobject or null
senderobjectRequired

A GitHub user.

installation_repositories

This event occurs when there is activity relating to which repositories a GitHub App installation can access. 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.

Availability

  • GitHub Apps

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: added

enterpriseobject

An enterprise on GitHub.

installationobjectRequired

Installation

organizationobject

A GitHub organization.

repositories_addedarray of objectsRequired

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

repositories_removedarray of objectsRequired

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

repositoryobject

A repository on GitHub.

repository_selectionstringRequired

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

Can be one of: all, selected

requesterobject or nullRequired
senderobjectRequired

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.

Availability

  • GitHub Apps

Webhook payload object

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
accountobjectRequired
actionstringRequired
changesobjectRequired
enterpriseobject

An enterprise on GitHub.

installationobjectRequired

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

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobject

A GitHub user.

target_typestringRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A comment on an issue or pull request was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

commentobjectRequired

The comment itself.

enterpriseobject

An enterprise on GitHub.

installationobject

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

issueRequired

The issue the comment belongs to.

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

An issue was assigned to a user.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

The action that was performed.

Value: assigned

assigneeobject or null
enterpriseobject

An enterprise on GitHub.

installationobject

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

issueobjectRequired

The issue itself.

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A label was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

enterpriseobject

An enterprise on GitHub.

installationobject

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

labelobjectRequired
organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobject

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.

Availability

  • GitHub Marketplace

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: cancelled

effective_datestringRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

marketplace_purchaseRequired
organizationobject

A GitHub organization.

previous_marketplace_purchaseobject
repositoryobject

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Enterprises
  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A GitHub user accepted an invitation to a repository.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: added

changesobject
enterpriseobject

An enterprise on GitHub.

installationobject

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

memberobject or nullRequired
organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Organizations
  • Enterprises
  • GitHub Apps

Webhook payload object

Action type

An organization member was added to a team.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: added

enterpriseobject

An enterprise on GitHub.

installationobject

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

memberobject or nullRequired
organizationobjectRequired

A GitHub organization.

repositoryobject

A repository on GitHub.

scopestringRequired

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

Value: team

senderobject or nullRequired
teamobjectRequired

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 limited private beta and subject to change.

Availability

  • GitHub Apps

Webhook payload object

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.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired
installationobject

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

merge_groupobjectRequired
organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobject

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.

Availability

  • GitHub Marketplace
  • Enterprises
  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

The webhook was deleted.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: deleted

enterpriseobject

An enterprise on GitHub.

hookobjectRequired

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

hook_idintegerRequired

The id of the modified webhook.

installationobject

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

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobject

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A milestone was closed.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: closed

enterpriseobject

An enterprise on GitHub.

installationobject

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

milestoneobjectRequired

A collection of related issues and pull requests.

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Organizations
  • Enterprises
  • GitHub Apps

Webhook payload object

Action type

A user was blocked from the organization.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: blocked

blocked_userobject or nullRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobjectRequired

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Organizations
  • Enterprises
  • GitHub Apps

Webhook payload object

Action type

An organization was deleted.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: deleted

enterpriseobject

An enterprise on GitHub.

installationobject

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

membershipobject

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

organizationobjectRequired

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A package was published to a registry.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: published

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

packageobjectRequired

Information about the package.

repositoryobject

A repository on GitHub.

senderobjectRequired

A GitHub user.

package_v2

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

A package was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: create

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobjectRequired

A GitHub organization.

packageobjectRequired
repositoryobject

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
buildobjectRequired
enterpriseobject

An enterprise on GitHub.

idintegerRequired
installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

ping

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

Availability

  • Repositories
  • Organizations
  • GitHub Apps
  • Enterprises
  • GitHub Marketplace

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
hookobject

The webhook that is being pinged

hook_idinteger

The ID of the webhook that triggered the ping.

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobject

A GitHub user.

zenstring

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: converted

changesobjectRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

project_cardobjectRequired
repositoryobject

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A classic project was closed.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: closed

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

projectobjectRequired
repositoryobject

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A column was added to a classic project.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

project_columnobjectRequired
repositoryobject

A repository on GitHub.

senderobject

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.

Availability

  • Organizations

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: archived

changesobjectRequired
installationobject

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

organizationobjectRequired

A GitHub organization.

projects_v2_itemobjectRequired

An item belonging to a project

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A pull request was assigned to a user.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: assigned

assigneeobject or nullRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

numberintegerRequired

The pull request number.

organizationobject

A GitHub organization.

pull_requestobjectRequired
repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A comment on a pull request diff was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

commentobjectRequired

The comment itself.

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

pull_requestobjectRequired
repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A review on a pull request was dismissed.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: dismissed

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

pull_requestobjectRequired
repositoryobjectRequired

A repository on GitHub.

reviewobjectRequired

The review that was affected.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: resolved

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

pull_requestobjectRequired
repositoryobjectRequired

A repository on GitHub.

senderobject

A GitHub user.

threadobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
afterstringRequired

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

base_refstring or nullRequired
beforestringRequired

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

commitsarray of objectsRequired

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.

comparestringRequired

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.

createdbooleanRequired

Whether this push created the ref.

deletedbooleanRequired

Whether this push deleted the ref.

enterpriseobject

An enterprise on GitHub.

forcedbooleanRequired

Whether this push was a force push of the ref.

head_commitobject or nullRequired
installationobject

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

organizationobject

A GitHub organization.

pusherobjectRequired

Metaproperties for Git author/committer information.

refstringRequired

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

repositoryobjectRequired

A git repository

senderobject

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A package was published to a registry.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: published

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

registry_packageobjectRequired
repositoryobject

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

releaseobjectRequired

The release object.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Enterprises
  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A repository was archived.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: archived

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • GitHub Apps

Webhook payload object

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired
branchstringRequired
client_payloadobject or nullRequired
enterpriseobject

An enterprise on GitHub.

installationobjectRequired

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

statusstringRequired

Can be one of: 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.

Availability

  • Repositories
  • Organizations

Webhook payload object

Action type

A repository vulnerability alert was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: create

alertRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

A secret scanning alert was created.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

alertobjectRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobject

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

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.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstring

Value: created

alertobjectRequired
installationobject

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

locationobjectRequired
organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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."

Availability

  • GitHub Apps

Webhook payload object

Action type

A security advisory was published to the GitHub community.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: published

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

security_advisoryobjectRequired

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

senderobject

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
changesobjectRequired
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

Full Repository

senderobject

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."

Availability

  • Sponsored accounts

Webhook payload object

Action type

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.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: cancelled

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobjectRequired

A GitHub user.

sponsorshipobjectRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

Someone starred a repository.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

starred_atstring or nullRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
avatar_urlstring or null
branchesarray of objectsRequired

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.

commitobjectRequired
contextstringRequired
created_atstringRequired
descriptionstring or nullRequired

The optional human-readable description added to the status.

enterpriseobject

An enterprise on GitHub.

idintegerRequired

The unique identifier of the status.

installationobject

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

namestringRequired
organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

shastringRequired

The Commit SHA.

statestringRequired

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

Can be one of: pending, success, failure, error

target_urlstring or nullRequired

The optional link added to the status.

updated_atstringRequired

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

teamobjectRequired

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.

Availability

  • Organizations
  • Enterprises
  • GitHub Apps

Webhook payload object

Action type

A team was granted access to a repository.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: added_to_repository

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobjectRequired

A GitHub organization.

repositoryobject

A git repository

senderobject

A GitHub user.

teamobjectRequired

Groups of organization members that gives permissions on specified repositories.

user

This event occurs when there is activity relating to user accounts in an enterprise.

Availability

  • Enterprises

Webhook payload object

A user account was added to the enterprise.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: created

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobject

A repository on GitHub.

senderobject

A GitHub user.

userobject or null

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.

Availability

  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Someone started watching the repository.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: started

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

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.

Availability

  • GitHub Apps

Webhook payload object

Headers
Name, Type, Description
Body parameters
Name, Type, Description
enterpriseobject

An enterprise on GitHub.

inputsobject or nullRequired
installationobject

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

organizationobject

A GitHub organization.

refstringRequired
repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

workflowstringRequired

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.

Availability

  • Enterprises
  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

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.

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: completed

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

workflow_jobRequired
deploymentobject

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.

Availability

  • Enterprises
  • Repositories
  • Organizations
  • GitHub Apps

Webhook payload object

Action type

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

Headers
Name, Type, Description
Body parameters
Name, Type, Description
actionstringRequired

Value: completed

enterpriseobject

An enterprise on GitHub.

installationobject

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

organizationobject

A GitHub organization.

repositoryobjectRequired

A repository on GitHub.

senderobjectRequired

A GitHub user.

workflowobject or nullRequired
workflow_runRequired