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, see "Creating 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 the team
event, but a repository webhook cannot. The description of each webhook event lists the availability for that event. For more information, see "Types 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 a create
event if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.
Delivery headers
HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers:
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-GitHub-Enterprise-Version
: The version of the GitHub Enterprise Server instance that sent the HTTP POST payload.X-GitHub-Enterprise-Host
: The hostname of the GitHub Enterprise Server instance that sent the HTTP POST payload.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, see "Validating 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, see "Example 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/2
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
> X-GitHub-Enterprise-Version: 2.15.0
> X-GitHub-Enterprise-Host: example.com
> 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": "http(s)://HOSTNAME/api/v3/repos/octocat/Hello-World/issues/1347",
> "number": 1347,
> ...
> },
> "repository" : {
> "id": 1296269,
> "full_name": "octocat/Hello-World",
> "owner": {
> "login": "octocat",
> "id": 1,
> ...
> },
> ...
> },
> "sender": {
> "login": "octocat",
> "id": 1,
> ...
> }
> }
branch_protection_rule
This event occurs when there is activity relating to branch protection rules. For more information, see "About protected branches." For information about the APIs to manage branch protection rules, see the GraphQL documentation or "Branch protection" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.
Disponibilidad para branch_protection_rule
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para branch_protection_rule
A branch protection rule was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
rule object RequeridoThe branch protection rule. Includes a |
Properties of |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
cache_sync
This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see "About repository caching."
Disponibilidad para cache_sync
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para cache_sync
Nombre, Tipo, Descripción |
---|
after string Requerido |
before string Requerido |
cache_location string Requerido |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
ref string Requerido |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
check_run
This event occurs when there is activity relating to a check run. For information about check runs, see "Getting started with the Checks API." For information about the APIs to manage check runs, see the GraphQL API documentation or "Check Runs" in the REST API documentation.
For activity relating to check suites, use the check-suite
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the rerequested
and requested_action
event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created
and completed
event types in repositories.
Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array and a null
value for head_branch
.
Disponibilidad para check_run
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para check_run
A check run was completed, and a conclusion is available.
Nombre, Tipo, Descripción |
---|
action string Valor: |
check_run object RequeridoA check performed on the code of a given code change |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
check_suite
This event occurs when there is activity relating to a check suite. For information about check suites, see "Getting started with the Checks API." For information about the APIs to manage check suites, see the GraphQL API documentation or "Check Suites" in the REST API documentation.
For activity relating to check runs, use the check_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the requested
and rerequested
event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed
event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array and a null
value for head_branch
.
Disponibilidad para check_suite
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para check_suite
All check runs in a check suite have completed, and a conclusion is available.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
check_suite object RequeridoThe check_suite. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilidad para code_scanning_alert
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para 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.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
alert object RequeridoThe code scanning alert involved in the event. |
Properties of |
commit_oid string RequeridoThe commit SHA of the code scanning alert. When the action is |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
ref string RequeridoThe Git reference of the code scanning alert. When the action is |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
commit_comment
This event occurs when there is activity relating to commit comments. For more information about commit comments, see "Commenting on a pull request." For information about the APIs to manage commit comments, see the GraphQL API documentation or "Commit comments" in the REST API documentation.
For activity relating to comments on pull request reviews, use the pull_request_review_comment
event. For activity relating to issue comments, use the issue_comment
event. For activity relating to discussion comments, use the discussion_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Disponibilidad para commit_comment
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para commit_comment
Someone commented on a commit.
Nombre, Tipo, Descripción |
---|
action string RequeridoThe action performed. Can be Valor: |
comment object RequeridoThe commit comment resource. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilidad para create
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para create
Nombre, Tipo, Descripción |
---|
description string or null RequeridoThe repository's current description. |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
master_branch string RequeridoThe name of the repository's default branch (usually |
organization object A GitHub organization. Webhook payloads contain the |
pusher_type string RequeridoThe pusher type for the event. Can be either |
ref string RequeridoThe |
ref_type string RequeridoThe type of Git ref object created in the repository. Puede ser uno de los siguientes: |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
delete
This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including
branch and tag deletions, use the push
webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Note: This event will not occur when more than three tags are deleted at once.
Disponibilidad para delete
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para delete
Nombre, Tipo, Descripción |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pusher_type string RequeridoThe pusher type for the event. Can be either |
ref string RequeridoThe |
ref_type string RequeridoThe type of Git ref object deleted in the repository. Puede ser uno de los siguientes: |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
dependabot_alert
This event occurs when there is activity relating to Dependabot alerts.
For more information about Dependabot alerts, see "About Dependabot alerts." For information about the API to manage Dependabot alerts, see "Dependabot alerts" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.
Note: Webhook events for Dependabot alerts are currently in beta and subject to change.
Disponibilidad para dependabot_alert
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para dependabot_alert
A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
alert object RequeridoA Dependabot alert. |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
deploy_key
This event occurs when there is activity relating to deploy keys. For more information, see "Managing deploy keys." For information about the APIs to manage deploy keys, see the GraphQL API documentation or "Deploy keys" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Disponibilidad para deploy_key
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para deploy_key
A deploy key was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
key object RequeridoThe |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
deployment
This event occurs when there is activity relating to deployments. For more information, see "About deployments." For information about the APIs to manage deployments, see the GraphQL API documentation or "Deployments" in the REST API documentation.
For activity relating to deployment status, use the deployment_status
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Disponibilidad para deployment
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para deployment
A deployment was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
deployment object RequeridoThe deployment. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow object or null Requerido |
Properties of |
workflow_run object or null Requerido |
Properties of |
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, see the GraphQL API documentation or "Deployments" in the REST API documentation.
For activity relating to deployment creation or deployment status, use the deployment
or deployment_status
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Disponibilidad para deployment_review
- Aplicaciones de GitHub
Objeto de carga útil del webhook para deployment_review
A deployment review was approved.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
approver object |
Properties of |
comment string |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object RequeridoA GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
reviewers array of objects |
Properties of |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
since string Requerido |
workflow_job_run object |
Properties of |
workflow_job_runs array of objects |
Properties of |
workflow_run object or null Requerido |
Properties of |
deployment_status
This event occurs when there is activity relating to deployment statuses. For more information, see "About deployments." For information about the APIs to manage deployments, see the GraphQL API documentation or "Deployments" in the REST API documentation.
For activity relating to deployment creation, use the deployment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Disponibilidad para deployment_status
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para deployment_status
A new deployment status was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
check_run object or null |
Properties of |
deployment object RequeridoThe deployment. |
Properties of |
deployment_status object RequeridoThe deployment status. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow object or null |
Properties of |
workflow_run object or null |
Properties of |
discussion
This event occurs when there is activity relating to a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.
For activity relating to a comment on a discussion, use the discussion_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
Note: Webhook events for GitHub Discussions are currently in beta and subject to change.
Disponibilidad para discussion
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para discussion
A comment on the discussion was marked as the answer.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
answer object Requerido |
Properties of |
discussion object RequeridoA Discussion in a repository. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
discussion_comment
This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.
For activity relating to a discussion as opposed to comments on a discussion, use the discussion
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
Note: Webhook events for GitHub Discussions are currently in beta and subject to change.
Disponibilidad para discussion_comment
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para discussion_comment
A comment on a discussion was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
comment object Requerido |
Properties of |
discussion object RequeridoA Discussion in a repository. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
enterprise
This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see "Enforcing repository management policies in your enterprise."
Disponibilidad para enterprise
- Empresas
Objeto de carga útil del webhook para enterprise
Anonymous Git read access was disabled.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilidad para fork
- Empresas
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para fork
Nombre, Tipo, Descripción |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
forkee object RequeridoThe created |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
github_app_authorization
This event occurs when a user revokes their authorization of a GitHub App. For more information, see "About apps." For information about the API to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
A GitHub App receives this webhook by default and cannot unsubscribe from this event.
Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials
error. For details about requests with a user access token, which require GitHub App authorization, see "Authenticating with a GitHub App on behalf of a user."
Disponibilidad para github_app_authorization
- Aplicaciones de GitHub
Objeto de carga útil del webhook para github_app_authorization
Someone revoked their authorization of a GitHub App.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilidad para gollum
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para gollum
Nombre, Tipo, Descripción |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pages array of objects RequeridoThe pages that were updated. |
Properties of |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
installation
This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
Disponibilidad para installation
- Aplicaciones de GitHub
Objeto de carga útil del webhook para installation
Someone installed a GitHub App on a user or organization account.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object RequeridoInstallation |
organization object A GitHub organization. Webhook payloads contain the |
repositories array of objects An array of repository objects that the installation can access. |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
requester object or null |
Properties of |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
installation_repositories
This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
Disponibilidad para installation_repositories
- Aplicaciones de GitHub
Objeto de carga útil del webhook para installation_repositories
A GitHub App installation was granted access to one or more repositories.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object RequeridoInstallation |
organization object A GitHub organization. Webhook payloads contain the |
repositories_added array of objects RequeridoAn array of repository objects, which were added to the installation. |
Properties of |
repositories_removed array of objects RequeridoAn array of repository objects, which were removed from the installation. |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
repository_selection string RequeridoDescribe whether all repositories have been selected or there's a selection involved Puede ser uno de los siguientes: |
requester object or null Requerido |
Properties of |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
installation_target
This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
Disponibilidad para installation_target
- Aplicaciones de GitHub
Objeto de carga útil del webhook para installation_target
Somebody renamed the user or organization account that a GitHub App is installed on.
Nombre, Tipo, Descripción |
---|
account object Requerido |
Properties of |
action string RequeridoValor: |
changes object Requerido |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object RequeridoThe GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
target_type string Requerido |
issue_comment
This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "About issues" and "About pull requests." For information about the APIs to manage issue comments, see the GraphQL documentation or "Issue comments" in the REST API documentation.
For activity relating to an issue as opposed to comments on an issue, use the issue
event. For activity related to pull request reviews or pull request review comments, use the pull_request_review
or pull_request_review_comment
events. For more information about the different types of pull request comments, see "Working with comments."
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
Disponibilidad para issue_comment
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para issue_comment
A comment on an issue or pull request was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
comment object RequeridoThe comment itself. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
issue object RequeridoThe issue the comment belongs to. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
issues
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
Disponibilidad para issues
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para issues
An issue was assigned to a user.
Nombre, Tipo, Descripción |
---|
action string RequeridoThe action that was performed. Valor: |
assignee object or null |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
issue object RequeridoThe issue itself. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
label
This event occurs when there is activity relating to labels. For more information, see "Managing labels." For information about the APIs to manage labels, see the GraphQL documentation or "Labels" in the REST API documentation.
If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled
or unlabeled
action type for the issues
, pull_request
, or discussion
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Disponibilidad para label
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para label
A label was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
label object Requerido |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
member
This event occurs when there is activity relating to collaborators in a repository. For more information, see "Adding outside collaborators to repositories in your organization." For more information about the API to manage repository collaborators, see the GraphQL API documentation or "Collaborators" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Disponibilidad para member
- Empresas
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para member
A GitHub user accepted an invitation to a repository.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
changes object |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
member object or null Requerido |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
membership
This event occurs when there is activity relating to team membership. For more information, see "About teams." For more information about the APIs to manage team memberships, see the GraphQL API documentation or "Team members" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Disponibilidad para membership
- Las organizaciones
- Empresas
- Aplicaciones de GitHub
Objeto de carga útil del webhook para membership
An organization member was added to a team.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
member object or null Requerido |
Properties of |
organization object RequeridoA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
scope string RequeridoThe scope of the membership. Currently, can only be Valor: |
sender object or null Requerido |
team object RequeridoGroups of organization members that gives permissions on specified repositories. |
Properties of |
meta
This event occurs when there is activity relating to a webhook itself.
To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission.
Disponibilidad para meta
- Marketplace de GitHub
- Empresas
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para meta
The webhook was deleted.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
hook object RequeridoThe modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. |
Properties of |
hook_id integer RequeridoThe id of the modified webhook. |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
milestone
This event occurs when there is activity relating to milestones. For more information, see "About milestones." For information about the APIs to manage milestones, see the GraphQL documentation or "Milestones" in the REST API documentation.
If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned
or demilestoned
action type for the issues
or pull_request
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.
Disponibilidad para milestone
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para milestone
A milestone was closed.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
milestone object RequeridoA collection of related issues and pull requests. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
organization
This event occurs when there is activity relating to an organization and its members. For more information, see "About organizations." For information about the APIs to manage organizations, see the GraphQL documentation or "Organizations" in the REST API documentation.
If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Disponibilidad para organization
- Las organizaciones
- Empresas
- Aplicaciones de GitHub
Objeto de carga útil del webhook para organization
An organization was deleted.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
membership object The membership between the user and the organization. Not present when the action is |
Properties of |
organization object RequeridoA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
package
This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or "Packages" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.
Disponibilidad para package
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para package
A package was published to a registry.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
package object RequeridoInformation about the package. |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilidad para page_build
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para page_build
Nombre, Tipo, Descripción |
---|
build object RequeridoThe List GitHub Pages builds itself. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
id integer Requerido |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
ping
This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.
Disponibilidad para ping
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
- Empresas
- Marketplace de GitHub
Objeto de carga útil del webhook para ping
Nombre, Tipo, Descripción |
---|
hook object The webhook that is being pinged |
Properties of |
hook_id integer The ID of the webhook that triggered the ping. |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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, see the 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 the project
and project_column
event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.
Disponibilidad para project_card
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para project_card
A note in a project (classic) was converted to an issue.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
changes object Requerido |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
project_card object Requerido |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
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, see the GraphQL API documentation or "Projects (classic)" in the REST API documentation.
For activity relating to a card or column on a project (classic), use the project_card
and project_column
event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.
Disponibilidad para project
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para project
A project (classic) was closed.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
project object Requerido |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
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, see the 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 the project
and project_card
event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.
Disponibilidad para project_column
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para project_column
A column was added to a project (classic).
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
project_column object Requerido |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
projects_v2
This event occurs when there is activity relating to an organization-level project. For more information, see "About Projects." For information about the Projects API, see the GraphQL documentation.
For activity relating to a item on a project, use the projects_v2_item
event. For activity relating to Projects (classic), use the project
, project_card
, and project_column
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
Disponibilidad para projects_v2
- Las organizaciones
Objeto de carga útil del webhook para projects_v2
A project in the organization was closed.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
installation object The GitHub App installation. Webhook payloads contain the |
organization object RequeridoA GitHub organization. Webhook payloads contain the |
projects_v2 object RequeridoA projects v2 project |
Properties of |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
projects_v2_item
This event occurs when there is activity relating to an item on an organization-level project. For more information, see "About Projects." For information about the Projects API, see the GraphQL documentation.
For activity relating to a project (instead of an item on a project), use the projects_v2
event. For activity relating to Projects (classic), use the project
, project_card
, and project_column
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
Disponibilidad para projects_v2_item
- Las organizaciones
Objeto de carga útil del webhook para projects_v2_item
An item on an organization project was archived. For more information, see "Archiving items from your project."
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
changes object Requerido |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object RequeridoA GitHub organization. Webhook payloads contain the |
projects_v2_item object RequeridoAn item belonging to a project |
Properties of |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilidad para public
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para public
Nombre, Tipo, Descripción |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
pull_request
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Disponibilidad para pull_request
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para pull_request
A pull request was assigned to a user.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
assignee object or null Requerido |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
number integer RequeridoThe pull request number. |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Requerido |
Properties of |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
pull_request_review_comment
This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "Commenting on a pull request." For information about the APIs to manage pull request review comments, see the GraphQL API documentation or "Pull request review comments" in the REST API documentation.
For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Disponibilidad para pull_request_review_comment
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para pull_request_review_comment
A comment on a pull request diff was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
comment object RequeridoThe comment itself. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Requerido |
Properties of |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
pull_request_review
This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "About pull request reviews." For information about the APIs to manage pull request reviews, see the GraphQL API documentation or "Pull request reviews" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Disponibilidad para pull_request_review
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para pull_request_review
A review on a pull request was dismissed.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Requerido |
Properties of |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
review object RequeridoThe review that was affected. |
Properties of |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
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, see the 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 the pull_request_review_comment
, issue_comment
, or pull_request_review
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Disponibilidad para pull_request_review_thread
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para pull_request_review_thread
A comment thread on a pull request was marked as resolved.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Requerido |
Properties of |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
thread object Requerido |
Properties of |
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 branch
and tag deletions, use the delete
webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Note: 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.
Disponibilidad para push
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para push
Nombre, Tipo, Descripción |
---|
after string RequeridoThe SHA of the most recent commit on |
base_ref string or null Requerido |
before string RequeridoThe SHA of the most recent commit on |
commits array of objects RequeridoAn array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the |
Properties of |
compare string RequeridoURL that shows the changes in this |
created boolean RequeridoWhether this push created the |
deleted boolean RequeridoWhether this push deleted the |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
forced boolean RequeridoWhether this push was a force push of the |
head_commit object or null Requerido |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pusher object RequeridoMetaproperties for Git author/committer information. |
Properties of |
ref string RequeridoThe full git ref that was pushed. Example: |
repository object RequeridoA git repository |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
registry_package
This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or "Packages" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.
Note: GitHub recommends that you use the newer package
event instead.
Disponibilidad para registry_package
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para registry_package
A package was published to a registry.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
registry_package object Requerido |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
release
This event occurs when there is activity relating to releases. For more information, see "About releases." For information about the APIs to manage releases, see the GraphQL API documentation or "Releases" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Disponibilidad para release
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para release
A draft was saved, or a release or pre-release was published without previously being saved as a draft.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
release object RequeridoThe release object. |
Properties of |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
repository
This event occurs when there is activity relating to repositories. For more information, see "About repositories." For information about the APIs to manage repositories, see the GraphQL documentation or "Repositories" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Disponibilidad para repository
- Aplicaciones de GitHub
- Empresas
- Las organizaciones
- Repositorios
Objeto de carga útil del webhook para repository
Someone disabled anonymous Git read access to the repository. For more information, see "Enabling anonymous Git read access for a repository."
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
repository_dispatch
This event occurs when a GitHub App sends a POST
request to /repos/{owner}/{repo}/dispatches
. For more information, see the REST API documentation for creating a repository dispatch event. In the payload, the action
will be the event_type
that was specified in the POST /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.
Disponibilidad para repository_dispatch
- Aplicaciones de GitHub
Objeto de carga útil del webhook para repository_dispatch
Nombre, Tipo, Descripción |
---|
action string RequeridoThe |
branch string Requerido |
client_payload object or null RequeridoThe |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object RequeridoThe GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
repository_vulnerability_alert
This event occurs when there is activity relating to a security vulnerability alert in a repository.
Note: This event is deprecated. Use the dependabot_alert
event instead.
Disponibilidad para repository_vulnerability_alert
- Repositorios
- Las organizaciones
Objeto de carga útil del webhook para repository_vulnerability_alert
A repository vulnerability alert was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
alert object RequeridoThe security alert of the vulnerable dependency. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
secret_scanning_alert
This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.
For activity relating to secret scanning alert locations, use the secret_scanning_alert_location
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
Disponibilidad para secret_scanning_alert
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para secret_scanning_alert
A secret scanning alert was created.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
alert object Requerido |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
secret_scanning_alert_location
This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.
For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.
For activity relating to secret scanning alerts, use the secret_scanning_alert
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
Disponibilidad para secret_scanning_alert_location
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para 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.
Nombre, Tipo, Descripción |
---|
action string Valor: |
alert object Requerido |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
location object Requerido |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
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, see the REST API documentation or the GraphQL documentation.
GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "About Dependabot alerts."
Disponibilidad para security_advisory
- Aplicaciones de GitHub
Objeto de carga útil del webhook para security_advisory
A security advisory was published to the GitHub community.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
security_advisory object RequeridoThe details of the security advisory, including summary, description, and severity. |
Properties of |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilidad para security_and_analysis
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para security_and_analysis
Nombre, Tipo, Descripción |
---|
changes object Requerido |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoFull Repository |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
sponsorship
This event occurs when there is activity relating to a sponsorship listing. For more information, see "About GitHub Sponsors." For information about the API to manage sponsors, see the GraphQL documentation.
You can only create a sponsorship webhook on GitHub.com. For more information, see "Configuring webhooks for events in your sponsored account."
Disponibilidad para sponsorship
- Cuentas patrocinadas
Objeto de carga útil del webhook para 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.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
sponsorship object Requerido |
Properties of |
star
This event occurs when there is activity relating to repository stars. For more information about stars, see "Saving repositories with stars." For information about the APIs to manage stars, see the GraphQL documentation or "Starring" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Disponibilidad para star
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para star
Someone starred a repository.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
starred_at string or null RequeridoThe time the star was created. This is a timestamp in ISO 8601 format: |
status
This event occurs when the status of a Git commit changes. For example, commits can be marked as error
, failure
, pending
, or success
. For more information, see "About status checks." For information about the APIs to manage commit statuses, see the GraphQL documentation or "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.
Disponibilidad para status
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para status
Nombre, Tipo, Descripción |
---|
avatar_url string or null |
branches array of objects RequeridoAn 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 |
commit object Requerido |
Properties of |
context string Requerido |
created_at string Requerido |
description string or null RequeridoThe optional human-readable description added to the status. |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
id integer RequeridoThe unique identifier of the status. |
installation object The GitHub App installation. Webhook payloads contain the |
name string Requerido |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
sha string RequeridoThe Commit SHA. |
state string RequeridoThe new state. Can be Puede ser uno de los siguientes: |
target_url string or null RequeridoThe optional link added to the status. |
updated_at string Requerido |
team_add
This event occurs when a team is added to a repository. For more information, see "Managing teams and people with access to your repository."
For activity relating to teams, see the teams
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Disponibilidad para team_add
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para team_add
Nombre, Tipo, Descripción |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
team object RequeridoGroups of organization members that gives permissions on specified repositories. |
Properties of |
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.
Disponibilidad para team
- Las organizaciones
- Empresas
- Aplicaciones de GitHub
Objeto de carga útil del webhook para team
A team was granted access to a repository.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object RequeridoA GitHub organization. Webhook payloads contain the |
repository object A git repository |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
team object RequeridoGroups of organization members that gives permissions on specified repositories. |
Properties of |
user
This event occurs when there is activity relating to user accounts in an enterprise.
Disponibilidad para user
- Empresas
Objeto de carga útil del webhook para user
A user account was added to the enterprise.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object The GitHub user that triggered the event. This property is included in every webhook payload. |
user object or null |
Properties of |
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.
Disponibilidad para watch
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para watch
Someone started watching the repository.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow_dispatch
This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "Manually running a workflow."
For activity relating to workflow runs, use the workflow_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Disponibilidad para workflow_dispatch
- Aplicaciones de GitHub
Objeto de carga útil del webhook para workflow_dispatch
Nombre, Tipo, Descripción |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
inputs object or null Requerido |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
ref string Requerido |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow string Requerido |
workflow_job
This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "Using jobs in a workflow." For information about the API to manage workflow jobs, see "Workflow jobs" in the REST API documentation.
For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.
Disponibilidad para workflow_job
- Empresas
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para 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.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow_job object Requerido |
Properties of |
deployment object A request for a specific ref(branch,sha,tag) to be deployed |
Properties of |
workflow_run
This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "About workflows." For information about the APIs to manage workflow runs, see the GraphQL documentation or "Workflow runs" in the REST API documentation.
For activity relating to a job in a workflow run, use the workflow_job
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.
Disponibilidad para workflow_run
- Empresas
- Repositorios
- Las organizaciones
- Aplicaciones de GitHub
Objeto de carga útil del webhook para workflow_run
A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
Nombre, Tipo, Descripción |
---|
action string RequeridoValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object RequeridoThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object RequeridoThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow object or null Requerido |
Properties of |
workflow_run object Requerido |
Properties of |