Webhook events and payloads

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

About webhook events and payloads

You can create webhooks that subscribe to the events listed on this page. To limit the number of HTTP requests to your server, you should only subscribe to the specific events that you plan on handling. For more information, seeCreating webhooks.

Each webhook event on this page includes a description of the webhook properties for that event. If the event has multiple actions, the properties corresponding to each action are included.

Each event is only available to specific types of webhooks. For example, an organization webhook can subscribe to theteam event, but a repository webhook cannot. The description of each webhook event lists the availability for that event. For more information, seeTypes of webhooks.

Payload cap

Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, on acreate 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:

X-GitHub-Hook-ID: The unique identifier of the webhook.
X-GitHub-Event: The name of the event that triggered the delivery.
X-GitHub-Delivery: A globally unique identifier (GUID) to identify the event.
X-Hub-Signature: This header is sent if the webhook is configured with asecret. This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and thesecret as the HMACkey.X-Hub-Signature is provided for compatibility with existing integrations. We recommend that you use the more secureX-Hub-Signature-256 instead.
X-Hub-Signature-256: This header is sent if the webhook is configured with asecret. This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and thesecret as the HMACkey. For more information, seeValidating webhook deliveries.
User-Agent: This header will always have the prefixGitHub-Hookshot/.
X-GitHub-Hook-Installation-Target-Type: The type of resource where the webhook was created.
X-GitHub-Hook-Installation-Target-ID: The unique identifier of the resource where the webhook was created.

To see what each header might look like in a webhook payload, seeExample webhook delivery.

Example webhook delivery

You can choose to have payloads delivered in JSON format (application/json) or as URL-encoded data (x-www-form-urlencoded). Following is an example of a webhook POST request that uses the JSON format.

>POST /payload HTTP/1.1>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>X-GitHub-Hook-ID: 292430182>X-GitHub-Hook-Installation-Target-ID: 79929171>X-GitHub-Hook-Installation-Target-Type: repository>{>"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_configuration

This event occurs when there is a change to branch protection configurations for a repository.For more information, see "About protected branches."For information about using the APIs to manage branch protection rules, see "Branch protection rule" in 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 for`branch_protection_configuration`

Repositories
Organizations
GitHub Apps

Webhook payload object for`branch_protection_configuration`

All branch protections were disabled for a repository.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`disabled`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.

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, seethe 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 for`branch_protection_rule`

Repositories
Organizations
GitHub Apps

Webhook payload object for`branch_protection_rule`

A branch protection rule was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`rule`objectRequired The branch protection rule. Includes a`name` and all thebranch 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.
Properties of`rule`
`sender`objectRequired 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, seethe GraphQL API documentation or "Check Runs" in the REST API documentation.

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

To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive thererequested andrequested_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 thecreated andcompleted event types in repositories.

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 emptypull_requests array and anull value forhead_branch.

Availability for`check_run`

Repositories
Organizations
GitHub Apps

Webhook payload object for`check_run`

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

Webhook request body parameters
Name, Type, Description
`action`string Value:`completed`
`check_run`objectRequired A check performed on the code of a given code change
Properties of`check_run`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe GraphQL API documentation or "Check Suites" in the REST API documentation.

For activity relating to check runs, use thecheck_run event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive therequested andrerequested 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 thecompleted event types in repositories.

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 emptypull_requests array and anull value forhead_branch.

Availability for`check_suite`

Repositories
Organizations
GitHub Apps

Webhook payload object for`check_suite`

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

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`completed`
`check_suite`objectRequired Thecheck_suite.
Properties of`check_suite`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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 for`code_scanning_alert`

Repositories
Organizations
GitHub Apps

Webhook payload object for`code_scanning_alert`

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.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`appeared_in_branch`
`alert`objectRequired The code scanning alert involved in the event.
Properties of`alert`
`commit_oid`stringRequired 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. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`ref`stringRequired 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`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe GraphQL API documentation or "Commit comments" in the REST API documentation.

For activity relating to comments on pull request reviews, use thepull_request_review_comment event. For activity relating to issue comments, use theissue_comment event. For activity relating to discussion comments, use thediscussion_comment event.

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

Availability for`commit_comment`

Repositories
Organizations
GitHub Apps

Webhook payload object for`commit_comment`

Someone commented on a commit.

Webhook request body parameters
Name, Type, Description
`action`stringRequired The action performed. Can be`created`. Value:`created`
`comment`objectRequired Thecommit comment resource.
Properties of`comment`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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.

Notes:

This event will not occur when more than three tags are created at once.
Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.

Availability for`create`

Repositories
Organizations
GitHub Apps

Webhook payload object for`create`

Webhook request body parameters
Name, Type, Description
`description`string or nullRequired The repository's current description.
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`master_branch`stringRequired The name of the repository's default branch (usually`main`).
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`pusher_type`stringRequired The pusher type for the event. Can be either`user` or a deploy key.
`ref`stringRequired The`git ref` resource.
`ref_type`stringRequired The type of Git ref object created in the repository. Can be one of:`tag`,`branch`
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.

custom_property

This event occurs when there is activity relating to a custom property.

For more information, see "Managing custom properties for repositories in your organization". For information about the APIs to manage custom properties, see "Custom properties" in the REST API documentation.

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

Availability for`custom_property`

Enterprises
Organizations
GitHub Apps

Webhook payload object for`custom_property`

A new custom property was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`definition`objectRequired Custom property defined on an organization
Properties of`definition`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`sender`object A GitHub user.

custom_property_values

This event occurs when there is activity relating to custom property values for a repository.

For more information, see "Managing custom properties for repositories in your organization". For information about the APIs to manage custom properties for a repository, see "Custom properties" in the REST API documentation.

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

Availability for`custom_property_values`

Repositories
Organizations
GitHub Apps

Webhook payload object for`custom_property_values`

The custom property values of a repository were updated.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`updated`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`sender`object A GitHub user.
`new_property_values`array of objectsRequired The new custom property values for the repository.
Properties of`new_property_values`
`old_property_values`array of objectsRequired The old custom property values for the repository.
Properties of`old_property_values`

delete

This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, includingbranch and tag deletions, use thepush webhook event.

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

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

Availability for`delete`

Repositories
Organizations
GitHub Apps

Webhook payload object for`delete`

Webhook request body parameters
Name, Type, Description
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`pusher_type`stringRequired The pusher type for the event. Can be either`user` or a deploy key.
`ref`stringRequired The`git ref` resource.
`ref_type`stringRequired The type of Git ref object deleted in the repository. Can be one of:`tag`,`branch`
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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.

Webhook events for Dependabot alerts are currently in public preview and subject to change.

Availability for`dependabot_alert`

Repositories
Organizations
GitHub Apps

Webhook payload object for`dependabot_alert`

A Dependabot alert was automatically closed by a Dependabot auto-triage rule.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`auto_dismissed`
`alert`objectRequired A Dependabot alert.
Properties of`alert`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 for`deploy_key`

Repositories
Organizations
GitHub Apps

Webhook payload object for`deploy_key`

A deploy key was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`key`objectRequired The`deploy key` resource.
Properties of`key`
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe GraphQL API documentation or "Deployments" in the REST API documentation.

For activity relating to deployment status, use thedeployment_status event.

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

Availability for`deployment`

Repositories
Organizations
GitHub Apps

Webhook payload object for`deployment`

A deployment was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`deployment`objectRequired Thedeployment.
Properties of`deployment`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`workflow`object or nullRequired
Properties of`workflow`
`workflow_run`object or nullRequired
Properties of`workflow_run`

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, seethe REST API documentation.

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

Availability for`deployment_protection_rule`

GitHub Apps

Webhook payload object for`deployment_protection_rule`

A deployment protection rule was requested for an environment.

Webhook request body parameters
Name, Type, Description
`action`string Value:`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
Properties of`deployment`
`pull_requests`array of objects
Properties of`pull_requests`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`sender`object A GitHub user.

deployment_review

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

For activity relating to deployment creation or deployment status, use thedeployment ordeployment_status event.

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

Availability for`deployment_review`

GitHub Apps

Webhook payload object for`deployment_review`

A deployment review was approved.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`approved`
`approver`object
Properties of`approver`
`comment`string
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`reviewers`array of objects
Properties of`reviewers`
`sender`objectRequired A GitHub user.
`since`stringRequired
`workflow_job_run`object
Properties of`workflow_job_run`
`workflow_job_runs`array of objects
Properties of`workflow_job_runs`
`workflow_run`object or nullRequired
Properties of`workflow_run`

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, seethe GraphQL API documentation or "Deployments" in the REST API documentation.

For activity relating to deployment creation, use thedeployment event.

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

A webhook event is not fired for deployment statuses with aninactive state.

Availability for`deployment_status`

Repositories
Organizations
GitHub Apps

Webhook payload object for`deployment_status`

A new deployment status was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`check_run`object or null
Properties of`check_run`
`deployment`objectRequired Thedeployment.
Properties of`deployment`
`deployment_status`objectRequired Thedeployment status.
Properties of`deployment_status`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`workflow`object or null
Properties of`workflow`
`workflow_run`object or null
Properties of`workflow_run`

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, seethe GraphQL documentation.

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

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

Webhook events for GitHub Discussions are currently in public preview and subject to change.

Availability for`discussion`

Repositories
Organizations
GitHub Apps

Webhook payload object for`discussion`

A comment on the discussion was marked as the answer.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`answered`
`answer`objectRequired
Properties of`answer`
`discussion`objectRequired A Discussion in a repository.
Properties of`discussion`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe GraphQL documentation.

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

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

Webhook events for GitHub Discussions are currently in public preview and subject to change.

Availability for`discussion_comment`

Repositories
Organizations
GitHub Apps

Webhook payload object for`discussion_comment`

A comment on a discussion was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`comment`objectRequired
Properties of`comment`
`discussion`objectRequired A Discussion in a repository.
Properties of`discussion`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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 for`fork`

Enterprises
Repositories
Organizations
GitHub Apps

Webhook payload object for`fork`

Webhook request body parameters
Name, Type, Description
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`forkee`objectRequired The created`repository` resource.
Properties of`forkee`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 theirGitHub 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 the401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see "Authenticating with a GitHub App on behalf of a user."

Availability for`github_app_authorization`

GitHub Apps

Webhook payload object for`github_app_authorization`

Someone revoked their authorization of a GitHub App.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`revoked`
`sender`objectRequired 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 for`gollum`

Repositories
Organizations
GitHub Apps

Webhook payload object for`gollum`

Webhook request body parameters
Name, Type, Description
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`pages`array of objectsRequired The pages that were updated.
Properties of`pages`
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe GraphQL API documentation or "Apps" in the REST API documentation.

Availability for`installation`

GitHub Apps

Webhook payload object for`installation`

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

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`objectRequired Installation
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repositories`array of objects An array of repository objects that the installation can access.
Properties of`repositories`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`requester`object or null
Properties of`requester`
`sender`objectRequired 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, seethe GraphQL API documentation or "Apps" in the REST API documentation.

Availability for`installation_repositories`

GitHub Apps

Webhook payload object for`installation_repositories`

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

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`added`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`objectRequired Installation
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repositories_added`array of objectsRequired An array of repository objects, which were added to the installation.
Properties of`repositories_added`
`repositories_removed`array of objectsRequired An array of repository objects, which were removed from the installation.
Properties of`repositories_removed`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`repository_selection`stringRequired Describe whether all repositories have been selected or there's a selection involved Can be one of:`all`,`selected`
`requester`object or nullRequired
Properties of`requester`
`sender`objectRequired 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, seethe GraphQL API documentation or "Apps" in the REST API documentation.

Availability for`installation_target`

GitHub Apps

Webhook payload object for`installation_target`

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

Webhook request body parameters
Name, Type, Description
`account`objectRequired
Properties of`account`
`action`stringRequired Value:`renamed`
`changes`objectRequired
Properties of`changes`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`objectRequired The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`object A GitHub user.
`target_type`stringRequired

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, seethe GraphQL documentation or "Issue comments" in the REST API documentation.

For activity relating to an issue as opposed to comments on an issue, use theissue event. For activity related to pull request reviews or pull request review comments, use thepull_request_review orpull_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" repository permission.

Availability for`issue_comment`

Repositories
Organizations
GitHub Apps

Webhook payload object for`issue_comment`

A comment on an issue or pull request was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`comment`objectRequired Thecomment itself.
Properties of`comment`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`issue`objectRequired Theissue the comment belongs to.
Properties of`issue`
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe GraphQL documentation or "Issues" in the REST API documentation.

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

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

Availability for`issues`

Repositories
Organizations
GitHub Apps

Webhook payload object for`issues`

An issue was assigned to a user.

Webhook request body parameters
Name, Type, Description
`action`stringRequired The action that was performed. Value:`assigned`
`assignee`object or null
Properties of`assignee`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`issue`objectRequired Theissue itself.
Properties of`issue`
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 thelabeled orunlabeled action type for theissues,pull_request, ordiscussion events instead.

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

Availability for`label`

Repositories
Organizations
GitHub Apps

Webhook payload object for`label`

A label was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`label`objectRequired
Properties of`label`
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`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, seethe GraphQL documentation or "GitHub Marketplace" in the REST API documentation.

Availability for`marketplace_purchase`

GitHub Marketplace

Webhook payload object for`marketplace_purchase`

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

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`cancelled`
`effective_date`stringRequired
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`marketplace_purchase`objectRequired
Properties of`marketplace_purchase`
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`previous_marketplace_purchase`object
Properties of`previous_marketplace_purchase`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 for`member`

Enterprises
Repositories
Organizations
GitHub Apps

Webhook payload object for`member`

A GitHub user accepted an invitation to a repository.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`added`
`changes`object
Properties of`changes`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`member`object or nullRequired
Properties of`member`
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 for`membership`

Organizations
Enterprises
GitHub Apps

Webhook payload object for`membership`

An organization member was added to a team.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`added`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`member`object or nullRequired
Properties of`member`
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`scope`stringRequired The scope of the membership. Currently, can only be`team`. Value:`team`
`sender`object or nullRequired
`team`objectRequired Groups of organization members that gives permissions on specified repositories.
Properties of`team`

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.

Availability for`merge_group`

GitHub Apps

Webhook payload object for`merge_group`

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.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`checks_requested`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`merge_group`objectRequired A group of pull requests that the merge queue has grouped together to be merged.
Properties of`merge_group`
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`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, seethe 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 themilestoned ordemilestoned action type for theissues orpull_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 for`milestone`

Repositories
Organizations
GitHub Apps

Webhook payload object for`milestone`

A milestone was closed.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`closed`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`milestone`objectRequired A collection of related issues and pull requests.
Properties of`milestone`
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 theorganization event instead.

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

Availability for`org_block`

Organizations
Enterprises
GitHub Apps

Webhook payload object for`org_block`

A user was blocked from the organization.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`blocked`
`blocked_user`object or nullRequired
Properties of`blocked_user`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 theorg_block event instead.

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

Availability for`organization`

Organizations
Enterprises
GitHub Apps

Webhook payload object for`organization`

An organization was deleted.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`deleted`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`membership`object The membership between the user and the organization. Not present when the action is`member_invited`.
Properties of`membership`
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 for`package`

Repositories
Organizations
GitHub Apps

Webhook payload object for`package`

A package was published to a registry.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`published`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`package`objectRequired Information about the package.
Properties of`package`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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 for`page_build`

Repositories
Organizations
GitHub Apps

Webhook payload object for`page_build`

Webhook request body parameters
Name, Type, Description
`build`objectRequired TheList GitHub Pages builds itself.
Properties of`build`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`id`integerRequired
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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.

Availability for`personal_access_token_request`

GitHub Apps
Organizations

Webhook payload object for`personal_access_token_request`

A fine-grained personal access token request was approved.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`approved`
`personal_access_token_request`objectRequired Details of a Personal Access Token Request.
Properties of`personal_access_token_request`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`sender`objectRequired A GitHub user.
`installation`objectRequired The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."

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 for`ping`

Repositories
Organizations
GitHub Apps
Enterprises
GitHub Marketplace

Webhook payload object for`ping`

Webhook request body parameters
Name, Type, Description
`hook`object The webhook that is being pinged
Properties of`hook`
`hook_id`integer The ID of the webhook that triggered the ping.
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`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 project (classic). For more information, see "About projects (classic)." For information about the API to manage classic projects, seethe GraphQL API documentation or "Projects (classic)" in the REST API documentation.

For activity relating to a project (classic) or a column on a project (classic), use theproject andproject_column event.

This event relates to projects (classic) only. For activity relating to the new Projects experience, use theprojects_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 for`project_card`

Repositories
Organizations
GitHub Apps

Webhook payload object for`project_card`

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

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`converted`
`changes`objectRequired
Properties of`changes`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`project_card`objectRequired
Properties of`project_card`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.

project

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

For activity relating to a card or column on a project (classic), use theproject_card andproject_column event.

This event relates to projects (classic) only. For activity relating to the new Projects experience, use theprojects_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 for`project`

Repositories
Organizations
GitHub Apps

Webhook payload object for`project`

A project (classic) was closed.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`closed`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`project`objectRequired
Properties of`project`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.

project_column

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

For activity relating to a project (classic) or a card on a project (classic), use theproject andproject_card event.

This event relates to projects (classic) only. For activity relating to the new Projects experience, use theprojects_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 for`project_column`

Repositories
Organizations
GitHub Apps

Webhook payload object for`project_column`

A column was added to a project (classic).

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`project_column`objectRequired
Properties of`project_column`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`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, seethe GraphQL documentation.

For activity relating to a item on a project, use theprojects_v2_item event. For activity relating to Projects (classic), use theproject,project_card, andproject_column events instead.

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

Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see theProjects webhook feedback discussion.

Availability for`projects_v2`

Organizations

Webhook payload object for`projects_v2`

A project in the organization was closed.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`closed`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`projects_v2`objectRequired A projects v2 project
Properties of`projects_v2`
`sender`objectRequired 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, seethe GraphQL documentation.

For activity relating to a project (instead of an item on a project), use theprojects_v2 event. For activity relating to Projects (classic), use theproject,project_card, andproject_column events instead.

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

Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see theProjects webhook feedback discussion.

Availability for`projects_v2_item`

Organizations

Webhook payload object for`projects_v2_item`

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

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`archived`
`changes`objectRequired
Properties of`changes`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`projects_v2_item`objectRequired An item belonging to a project
Properties of`projects_v2_item`
`sender`objectRequired A GitHub user.

projects_v2_status_update

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "About Projects."

For activity relating to a project, use theprojects_v2 event.

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

To share feedback about projects webhooks with GitHub, see theProjects webhook feedback discussion.

Availability for`projects_v2_status_update`

Organizations

Webhook payload object for`projects_v2_status_update`

A status update was added to a project in the organization.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`projects_v2_status_update`objectRequired An status update belonging to a project
Properties of`projects_v2_status_update`
`sender`objectRequired 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 for`public`

Repositories
Organizations
GitHub Apps

Webhook payload object for`public`

Webhook request body parameters
Name, Type, Description
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 thepull_request_review,pull_request_review_comment,issue_comment, orpull_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 for`pull_request`

Repositories
Organizations
GitHub Apps

Webhook payload object for`pull_request`

A pull request was assigned to a user.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`assigned`
`assignee`object or nullRequired
Properties of`assignee`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`number`integerRequired The pull request number.
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`pull_request`objectRequired
Properties of`pull_request`
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 thepull_request_review,issue_comment, orpull_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 for`pull_request_review_comment`

Repositories
Organizations
GitHub Apps

Webhook payload object for`pull_request_review_comment`

A comment on a pull request diff was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`comment`objectRequired Thecomment itself.
Properties of`comment`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`pull_request`objectRequired
Properties of`pull_request`
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 thepull_request_review_comment,issue_comment, orpull_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 for`pull_request_review`

Repositories
Organizations
GitHub Apps

Webhook payload object for`pull_request_review`

A review on a pull request was dismissed.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`dismissed`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`pull_request`objectRequired
Properties of`pull_request`
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`review`objectRequired The review that was affected.
Properties of`review`
`sender`objectRequired 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 reviews, seethe GraphQL API documentation or "Pull request review comments" in the REST API documentation.

For activity related to pull request review comments, pull request comments, or pull request reviews, use thepull_request_review_comment,issue_comment, orpull_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 for`pull_request_review_thread`

Repositories
Organizations
GitHub Apps

Webhook payload object for`pull_request_review_thread`

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

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`resolved`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`pull_request`objectRequired
Properties of`pull_request`
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`object A GitHub user.
`thread`objectRequired
Properties of`thread`

push

This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branchand tag deletions, use thedelete webhook event.

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

Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.

Availability for`push`

Repositories
Organizations
GitHub Apps

Webhook payload object for`push`

Webhook request body parameters
Name, Type, Description
`after`stringRequired The SHA of the most recent commit on`ref` after the push.
`base_ref`string or nullRequired
`before`stringRequired The SHA of the most recent commit on`ref` before the push.
`commits`array 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 2048 commits. If necessary, you can use theCommits API to fetch additional commits.
Properties of`commits`
`compare`stringRequired 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`booleanRequired Whether this push created the`ref`.
`deleted`booleanRequired Whether this push deleted the`ref`.
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`forced`booleanRequired Whether this push was a force push of the`ref`.
`head_commit`object or nullRequired
Properties of`head_commit`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`pusher`objectRequired Metaproperties for Git author/committer information.
Properties of`pusher`
`ref`stringRequired The full git ref that was pushed. Example:`refs/heads/main` or`refs/tags/v3.14.1`.
`repository`objectRequired A git repository
`sender`object A GitHub user.

registry_package

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

GitHub recommends that you use the newerpackage event instead.

Availability for`registry_package`

Repositories
Organizations
GitHub Apps

Webhook payload object for`registry_package`

A package was published to a registry.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`published`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`registry_package`objectRequired
Properties of`registry_package`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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, seethe 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 for`release`

Repositories
Organizations
GitHub Apps

Webhook payload object for`release`

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

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`release`objectRequired Therelease object.
Properties of`release`
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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.

Availability for`repository_advisory`

Repositories
Organizations
GitHub Apps

Webhook payload object for`repository_advisory`

A repository security advisory was published.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`published`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`repository_advisory`objectRequired A repository security advisory.
Properties of`repository_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, seethe 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 for`repository`

Enterprises
Repositories
Organizations
GitHub Apps

Webhook payload object for`repository`

A repository was archived.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`archived`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.

repository_dispatch

This event occurs when a GitHub App sends aPOST request to/repos/{owner}/{repo}/dispatches. For more information, seethe REST API documentation for creating a repository dispatch event. In the payload, theaction will be theevent_type that was specified in thePOST /repos/{owner}/{repo}/dispatches request body.

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

Availability for`repository_dispatch`

GitHub Apps

Webhook payload object for`repository_dispatch`

Webhook request body parameters
Name, Type, Description
`action`stringRequired The`event_type` that was specified in the`POST /repos/{owner}/{repo}/dispatches` request body.
`branch`stringRequired
`client_payload`object or nullRequired The`client_payload` that was specified in the`POST /repos/{owner}/{repo}/dispatches` request body.
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`objectRequired The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.

repository_import

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

Availability for`repository_import`

Repositories
Organizations

Webhook payload object for`repository_import`

Webhook request body parameters
Name, Type, Description
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`status`stringRequired Can be one of:`success`,`cancelled`,`failure`

repository_ruleset

This event occurs when there is activity relating to repository rulesets.For more information about repository rulesets, see "Managing rulesets."For more information on managing rulesets via the APIs, seeRepository ruleset in the GraphQL documentation or "Repository rules" and "Organization rules in the REST API documentation."

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

Availability for`repository_ruleset`

Repositories
Organizations
GitHub Apps

Webhook payload object for`repository_ruleset`

A repository ruleset was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`repository_ruleset`objectRequired A set of rules to apply when specified conditions are met.
Properties of`repository_ruleset`
`sender`objectRequired A GitHub user.

repository_vulnerability_alert

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

Closing down notice: This event is closing down. Use thedependabot_alert event instead.

Availability for`repository_vulnerability_alert`

Repositories
Organizations

Webhook payload object for`repository_vulnerability_alert`

A repository vulnerability alert was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`create`
`alert`objectRequired The security alert of the vulnerable dependency.
Properties of`alert`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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 thesecret_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 for`secret_scanning_alert`

Repositories
Organizations
GitHub Apps

Webhook payload object for`secret_scanning_alert`

A secret scanning alert was created.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`alert`objectRequired
Properties of`alert`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`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 thesecret_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 for`secret_scanning_alert_location`

Repositories
Organizations
GitHub Apps

Webhook payload object for`secret_scanning_alert_location`

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.

Webhook request body parameters
Name, Type, Description
`action`string Value:`created`
`alert`objectRequired
Properties of`alert`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`location`objectRequired
Properties of`location`
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.

secret_scanning_scan

This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "About secret scanning."

Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updatesto patterns from partners. For more information on custom patterns, see "About custom patterns."

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

Availability for`secret_scanning_scan`

Repositories
Organizations
GitHub Apps

Webhook payload object for`secret_scanning_scan`

A secret scanning scan was completed.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`completed`
`type`stringRequired What type of scan was completed Can be one of:`backfill`,`custom-pattern-backfill`,`pattern-version-backfill`
`source`stringRequired What type of content was scanned Can be one of:`git`,`issues`,`pull-requests`,`discussions`,`wiki`
`started_at`stringRequired The time that the alert was resolved in ISO 8601 format:`YYYY-MM-DDTHH:MM:SSZ`.
`completed_at`stringRequired The time that the alert was resolved in ISO 8601 format:`YYYY-MM-DDTHH:MM:SSZ`.
`secret_types`array of strings or null List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates
`custom_pattern_name`string or null If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated
`custom_pattern_scope`string or null If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated Can be one of:`repository`,`organization`,`enterprise`,`null`
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`sender`object A GitHub user.

security_advisory

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "About global security advisories." For information about the API to manage security advisories, seethe REST API documentation orthe GraphQL documentation.

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

Availability for`security_advisory`

GitHub Apps

Webhook payload object for`security_advisory`

A security advisory was published to the GitHub community.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`published`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`security_advisory`objectRequired The details of the security advisory, including summary, description, and severity.
Properties of`security_advisory`
`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.

Availability for`security_and_analysis`

Repositories
Organizations
GitHub Apps

Webhook payload object for`security_and_analysis`

Webhook request body parameters
Name, Type, Description
`changes`objectRequired
Properties of`changes`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired 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, seethe 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 for`sponsorship`

Sponsored accounts

Webhook payload object for`sponsorship`

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.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`cancelled`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`sponsorship`objectRequired
Properties of`sponsorship`

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, seethe 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 for`star`

Repositories
Organizations
GitHub Apps

Webhook payload object for`star`

Someone starred a repository.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`created`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`starred_at`string 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 aserror,failure,pending, orsuccess. For more information, see "About status checks." For information about the APIs to manage commit statuses, seethe GraphQL documentation or "Commit 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 for`status`

Repositories
Organizations
GitHub Apps

Webhook payload object for`status`

Webhook request body parameters
Name, Type, Description
`avatar_url`string or null
`branches`array 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.
Properties of`branches`
`commit`objectRequired
Properties of`commit`
`context`stringRequired
`created_at`stringRequired
`description`string or nullRequired The optional human-readable description added to the status.
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`id`integerRequired The unique identifier of the status.
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`name`stringRequired
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`sha`stringRequired The Commit SHA.
`state`stringRequired The new state. Can be`pending`,`success`,`failure`, or`error`. Can be one of:`pending`,`success`,`failure`,`error`
`target_url`string or nullRequired The optional link added to the status.
`updated_at`stringRequired

sub_issues

This event occurs when there is activity relating to sub-issues.

For activity relating to issues more generally, use theissues event instead.

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

Availability for`sub_issues`

Repositories
Organizations
GitHub Apps

Webhook payload object for`sub_issues`

A parent issue was added to an issue.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`parent_issue_added`
`parent_issue_id`numberRequired The ID of the parent issue.
`parent_issue`objectRequired Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
Properties of`parent_issue`
`parent_issue_repo`objectRequired A repository on GitHub.
Properties of`parent_issue_repo`
`sub_issue_id`numberRequired The ID of the sub-issue.
`sub_issue`objectRequired Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
Properties of`sub_issue`
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`object A GitHub user.

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 theteams event.

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

Availability for`team_add`

Repositories
Organizations
GitHub Apps

Webhook payload object for`team_add`

Webhook request body parameters
Name, Type, Description
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`team`objectRequired Groups of organization members that gives permissions on specified repositories.
Properties of`team`

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 for`team`

Organizations
Enterprises
GitHub Apps

Webhook payload object for`team`

A team was granted access to a repository.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`added_to_repository`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`objectRequired A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`object A git repository
`sender`object A GitHub user.
`team`objectRequired Groups of organization members that gives permissions on specified repositories.
Properties of`team`

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 for`watch`

Repositories
Organizations
GitHub Apps

Webhook payload object for`watch`

Someone started watching the repository.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`started`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired 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 theworkflow_run event.

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

Availability for`workflow_dispatch`

GitHub Apps

Webhook payload object for`workflow_dispatch`

Webhook request body parameters
Name, Type, Description
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`inputs`object or nullRequired
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`ref`stringRequired
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`workflow`stringRequired

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 theworkflow_run event.

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

Availability for`workflow_job`

Enterprises
Repositories
Organizations
GitHub Apps

Webhook payload object for`workflow_job`

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.

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`completed`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`workflow_job`objectRequired
Properties of`workflow_job`
`deployment`object A request for a specific ref(branch,sha,tag) to be deployed
Properties of`deployment`

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, seethe GraphQL documentation or "Workflow runs" in the REST API documentation.

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

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

Availability for`workflow_run`

Enterprises
Repositories
Organizations
GitHub Apps

Webhook payload object for`workflow_run`

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

Webhook request body parameters
Name, Type, Description
`action`stringRequired Value:`completed`
`enterprise`object An enterprise on GitHub. Webhook payloads contain the`enterprise` property when the webhook is configuredon an enterprise account or an organization that's part of an enterprise account. For more information,see "About enterprise accounts."
`installation`object The GitHub App installation. Webhook payloads contain the`installation` property when the event is configuredfor and sent to a GitHub App. For more information,see "Using webhooks with GitHub Apps."
`organization`object A GitHub organization. Webhook payloads contain the`organization` property when the webhook is configured for anorganization, or when the event occurs from activity in a repository owned by an organization.
`repository`objectRequired The repository on GitHub where the event occurred. Webhook payloads contain the`repository` propertywhen the event occurs from activity in a repository.
`sender`objectRequired A GitHub user.
`workflow`object or nullRequired
Properties of`workflow`
`workflow_run`objectRequired
Properties of`workflow_run`

Movatterモバイル変換

Webhook events and payloads

In this article

Availability forbranch_protection_configuration

Webhook payload object forbranch_protection_configuration

Availability forbranch_protection_rule

Webhook payload object forbranch_protection_rule

Availability forcheck_run

Webhook payload object forcheck_run

Availability forcheck_suite

Webhook payload object forcheck_suite

Availability forcode_scanning_alert

Webhook payload object forcode_scanning_alert

Availability forcommit_comment

Webhook payload object forcommit_comment

Availability forcreate

Webhook payload object forcreate

Availability forcustom_property

Webhook payload object forcustom_property

Availability forcustom_property_values

Webhook payload object forcustom_property_values

Availability fordelete

Webhook payload object fordelete

Availability fordependabot_alert

Webhook payload object fordependabot_alert

Availability fordeploy_key

Webhook payload object fordeploy_key

Availability fordeployment

Webhook payload object fordeployment

Availability fordeployment_protection_rule

Webhook payload object fordeployment_protection_rule

Availability fordeployment_review

Webhook payload object fordeployment_review

Availability fordeployment_status

Webhook payload object fordeployment_status

Availability fordiscussion

Webhook payload object fordiscussion

Availability fordiscussion_comment

Webhook payload object fordiscussion_comment

Availability forfork

Webhook payload object forfork

Availability forgithub_app_authorization

Webhook payload object forgithub_app_authorization

Availability forgollum

Webhook payload object forgollum

Availability forinstallation

Webhook payload object forinstallation

Availability forinstallation_repositories

Webhook payload object forinstallation_repositories

Availability forinstallation_target

Webhook payload object forinstallation_target

Availability forissue_comment

Webhook payload object forissue_comment

Availability forissues

Webhook payload object forissues

Availability forlabel

Webhook payload object forlabel

Availability formarketplace_purchase

Webhook payload object formarketplace_purchase

Availability formember

Webhook payload object formember

Availability formembership

Webhook payload object formembership

Availability formerge_group

Webhook payload object formerge_group

Availability formeta

Webhook payload object formeta

Availability formilestone

Webhook payload object formilestone

Availability fororg_block

Webhook payload object fororg_block

Availability fororganization

Webhook payload object fororganization

Availability forpackage

Webhook payload object forpackage

Availability forpage_build

Webhook payload object forpage_build

Availability forpersonal_access_token_request

Webhook payload object forpersonal_access_token_request

Availability forping

Availability for`branch_protection_configuration`

Webhook payload object for`branch_protection_configuration`

Availability for`branch_protection_rule`

Webhook payload object for`branch_protection_rule`

Availability for`check_run`

Webhook payload object for`check_run`

Availability for`check_suite`

Webhook payload object for`check_suite`

Availability for`code_scanning_alert`

Webhook payload object for`code_scanning_alert`

Availability for`commit_comment`

Webhook payload object for`commit_comment`

Availability for`create`

Webhook payload object for`create`

Availability for`custom_property`

Webhook payload object for`custom_property`

Availability for`custom_property_values`

Webhook payload object for`custom_property_values`

Availability for`delete`

Webhook payload object for`delete`

Availability for`dependabot_alert`

Webhook payload object for`dependabot_alert`

Availability for`deploy_key`

Webhook payload object for`deploy_key`

Availability for`deployment`

Webhook payload object for`deployment`

Availability for`deployment_protection_rule`

Webhook payload object for`deployment_protection_rule`

Availability for`deployment_review`

Webhook payload object for`deployment_review`

Availability for`deployment_status`

Webhook payload object for`deployment_status`

Availability for`discussion`

Webhook payload object for`discussion`

Availability for`discussion_comment`

Webhook payload object for`discussion_comment`

Availability for`fork`

Webhook payload object for`fork`

Availability for`github_app_authorization`

Webhook payload object for`github_app_authorization`

Availability for`gollum`

Webhook payload object for`gollum`

Availability for`installation`

Webhook payload object for`installation`

Availability for`installation_repositories`

Webhook payload object for`installation_repositories`

Availability for`installation_target`

Webhook payload object for`installation_target`

Availability for`issue_comment`

Webhook payload object for`issue_comment`

Availability for`issues`

Webhook payload object for`issues`

Availability for`label`

Webhook payload object for`label`

Availability for`marketplace_purchase`

Webhook payload object for`marketplace_purchase`

Availability for`member`

Webhook payload object for`member`

Availability for`membership`

Webhook payload object for`membership`

Availability for`merge_group`

Webhook payload object for`merge_group`

Availability for`meta`

Webhook payload object for`meta`

Availability for`milestone`

Webhook payload object for`milestone`

Availability for`org_block`

Webhook payload object for`org_block`

Availability for`organization`

Webhook payload object for`organization`

Availability for`package`

Webhook payload object for`package`

Availability for`page_build`

Webhook payload object for`page_build`

Availability for`personal_access_token_request`

Webhook payload object for`personal_access_token_request`

Availability for`ping`

Webhook payload object for`ping`

Availability for`project_card`

Webhook payload object for`project_card`