Sobre conteúdo e eventos de webhook
Você pode criar webhooks que assinam os eventos listados nesta página. Para limitar o número de solicitações HTTP feitas ao servidor, você deve inscrever apenas os eventos específicos que planeja manipular. Para obter mais informações, confira "Criar webhooks".
Cada evento de webhook nessa página inclui uma descrição das propriedades de webhook para esse evento. Se o evento tiver várias ações, as propriedades correspondentes a cada ação serão incluídas.
Cada evento está disponível apenas para tipos específicos de webhooks. Por exemplo, um webhook de organização pode se inscrever no evento team
, mas um webhook de repositório não pode. A descrição de cada evento de webhook lista a disponibilidade para esse evento. Para obter mais informações, confira "Tipos de webhooks".
Limite de conteúdo
O conteúdo é limitado a 25 MB. Se um evento gerar um conteúdo maior, o GitHub não entregará conteúdo para esse evento de webhook. Isso pode acontecer, por exemplo, em um evento create
, caso muitos branches ou muitas marcas sejam enviados por push de uma só vez. Sugerimos monitorar o tamanho da sua carga para garantir a entrega.
Cabeçalhos de entrega
As cargas de HTTP POST que são entregues no ponto de extremidade da URL configurado do seu webhook conterão vários cabeçalhos especiais:
X-GitHub-Hook-ID
: o identificador exclusivo do webhook.X-GitHub-Event
: o nome do evento que disparou a entrega.X-GitHub-Delivery
: um identificador global exclusivo (GUID) usado para identificar o evento.X-GitHub-Enterprise-Version
: a versão da instância do GitHub Enterprise Server que enviou o conteúdo HTTP POST.X-GitHub-Enterprise-Host
: o nome do host da instância do GitHub Enterprise Server que enviou o conteúdo HTTP POST.X-Hub-Signature
: esse cabeçalho será enviado se o webhook estiver configurado com umsecret
. Este é o resumo hexadecimal HMAC do corpo da solicitação, e é gerado por meio da função hash SHA-1 e dosecret
como akey
do HMAC. OX-Hub-Signature
é fornecido para compatibilidade com integrações existentes. Recomendamos que você use oX-Hub-Signature-256
mais seguro em vez disso.X-Hub-Signature-256
: esse cabeçalho será enviado se o webhook estiver configurado com umsecret
. Este é o resumo hexadecimal HMAC do corpo da solicitação, e é gerado por meio da função hash SHA-256 e dosecret
como akey
do HMAC. Para obter mais informações, confira "Validação de entregas de webhooks".User-Agent
: esse cabeçalho sempre terá o prefixoGitHub-Hookshot/
.X-GitHub-Hook-Installation-Target-Type
: o tipo de recurso onde o webhook foi criado.X-GitHub-Hook-Installation-Target-ID
: o identificador exclusivo do recurso onde o webhook foi criado.
Para ver a aparência de cada cabeçalho em um conteúdo de webhook, consulte "Exemplo de entrega de webhook".
Exemplo de entrega de webhook
Você pode optar por ter conteúdo entregue no formato JSON (application/json
) ou como dados codificados por URL (x-www-form-urlencoded
). A seguir está um exemplo de uma solicitação POST de webhook que usa o formato JSON.
> 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_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.
Disponibilidade para branch_protection_configuration
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para branch_protection_configuration
All branch protections were disabled for a repository.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA 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, 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.
Disponibilidade para branch_protection_rule
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para branch_protection_rule
A branch protection rule was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
rule object ObrigatórioThe branch protection rule. Includes a |
Properties of |
sender object ObrigatórioA GitHub user. |
bypass_request_secret_scanning
This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
For more information, see "Enabling delegated bypass for push protection."
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
Note: Delegated bypass for push protection is currently in public preview and subject to change.
Disponibilidade para bypass_request_secret_scanning
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para bypass_request_secret_scanning
A secret scanning push protection bypass request was cancelled.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 |
exemption_request object ObrigatórioA request from a user to be exempted from a set of rules. |
Properties of |
sender object ObrigatórioA GitHub user. |
cache_sync
This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see "About repository caching."
Disponibilidade para cache_sync
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para cache_sync
Nome, Tipo, Descrição |
---|
after string Obrigatório |
before string Obrigatório |
cache_location string Obrigatório |
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 Obrigatório |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object A GitHub user. |
check_run
This event occurs when there is activity relating to a check run. For information about check runs, see "Getting started with the Checks API." For information about the APIs to manage check runs, see the GraphQL API documentation or "Check Runs" in the REST API documentation.
For activity relating to check suites, use the check-suite
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the rerequested
and requested_action
event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created
and completed
event types in repositories.
Note
The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array and a null
value for head_branch
.
Disponibilidade para check_run
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para check_run
A check run was completed, and a conclusion is available.
Nome, Tipo, Descrição |
---|
action string Valor: |
check_run object ObrigatórioA 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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
check_suite
This event occurs when there is activity relating to a check suite. For information about check suites, see "Getting started with the Checks API." For information about the APIs to manage check suites, see the GraphQL API documentation or "Check Suites" in the REST API documentation.
For activity relating to check runs, use the check_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the requested
and rerequested
event types, the app must have at 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
.
Disponibilidade para check_suite
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para check_suite
All check runs in a check suite have completed, and a conclusion is available.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
check_suite object ObrigatórioThe 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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA 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.
Disponibilidade para code_scanning_alert
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do 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.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
alert object ObrigatórioThe code scanning alert involved in the event. |
Properties of |
commit_oid string ObrigatórioThe 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 ObrigatórioThe Git reference of the code scanning alert. When the action is |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
commit_comment
This event occurs when there is activity relating to commit comments. For more information about commit comments, see "Commenting on a pull request." For information about the APIs to manage commit comments, see the GraphQL API documentation or "Commit comments" in the REST API documentation.
For activity relating to comments on pull request reviews, use the pull_request_review_comment
event. For activity relating to issue comments, use the issue_comment
event. For activity relating to discussion comments, use the discussion_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Disponibilidade para commit_comment
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para commit_comment
Someone commented on a commit.
Nome, Tipo, Descrição |
---|
action string ObrigatórioThe action performed. Can be Valor: |
comment object ObrigatórioThe 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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA 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.
Disponibilidade para create
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para create
Nome, Tipo, Descrição |
---|
description string or null ObrigatórioThe 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 ObrigatórioThe name of the repository's default branch (usually |
organization object A GitHub organization. Webhook payloads contain the |
pusher_type string ObrigatórioThe pusher type for the event. Can be either |
ref string ObrigatórioThe |
ref_type string ObrigatórioThe type of Git ref object created in the repository. Pode ser um dos: |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
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.
Disponibilidade para delete
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para delete
Nome, Tipo, Descrição |
---|
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 ObrigatórioThe pusher type for the event. Can be either |
ref string ObrigatórioThe |
ref_type string ObrigatórioThe type of Git ref object deleted in the repository. Pode ser um dos: |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
dependabot_alert
This event occurs when there is activity relating to Dependabot alerts.
For more information about Dependabot alerts, see "About Dependabot alerts." For information about the API to manage Dependabot alerts, see "Dependabot alerts" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.
Note
Webhook events for Dependabot alerts are currently in public preview and subject to change.
Disponibilidade para dependabot_alert
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para dependabot_alert
A Dependabot alert was automatically closed by a Dependabot auto-triage rule.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
alert object ObrigatórioA 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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
deploy_key
This event occurs when there is activity relating to deploy keys. For more information, see "Managing deploy keys." For information about the APIs to manage deploy keys, see the GraphQL API documentation or "Deploy keys" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Disponibilidade para deploy_key
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para deploy_key
A deploy key was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
key object ObrigatórioThe |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
deployment
This event occurs when there is activity relating to deployments. For more information, see "About deployments." For information about the APIs to manage deployments, see the GraphQL API documentation or "Deployments" in the REST API documentation.
For activity relating to deployment status, use the deployment_status
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Disponibilidade para deployment
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para deployment
A deployment was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
deployment object ObrigatórioThe 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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
workflow object or null Obrigatório |
Properties of |
workflow_run object or null Obrigatório |
Properties of |
deployment_protection_rule
This event occurs when there is activity relating to deployment protection rules. For more information, see "Using environments for deployment." For information about the API to manage deployment protection rules, see the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.
Disponibilidade para deployment_protection_rule
- Aplicativos GitHub
Objeto da carga do webhook para deployment_protection_rule
A deployment protection rule was requested for an environment.
Nome, Tipo, Descrição |
---|
action string Valor: |
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 |
pull_requests array of objects |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
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, 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.
Disponibilidade para deployment_review
- Aplicativos GitHub
Objeto da carga do webhook para deployment_review
A deployment review was approved.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioA GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
reviewers array of objects |
Properties of |
sender object ObrigatórioA GitHub user. |
since string Obrigatório |
workflow_job_run object |
Properties of |
workflow_job_runs array of objects |
Properties of |
workflow_run object or null Obrigatório |
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.
Note
A webhook event is not fired for deployment statuses with an inactive
state.
Disponibilidade para deployment_status
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para deployment_status
A new deployment status was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
check_run object or null |
Properties of |
deployment object ObrigatórioThe deployment. |
Properties of |
deployment_status object ObrigatórioThe 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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
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 public preview and subject to change.
Disponibilidade para discussion
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para discussion
A comment on the discussion was marked as the answer.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
answer object Obrigatório |
Properties of |
discussion object ObrigatórioA 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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
discussion_comment
This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.
For activity relating to a discussion as opposed to comments on a discussion, use the discussion
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
Note
Webhook events for GitHub Discussions are currently in public preview and subject to change.
Disponibilidade para discussion_comment
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para discussion_comment
A comment on a discussion was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
comment object Obrigatório |
Properties of |
discussion object ObrigatórioA 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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
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."
Disponibilidade para enterprise
- Enterprises
Objeto da carga do webhook para enterprise
Anonymous Git read access was disabled.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
sender object A GitHub user. |
fork
This event occurs when someone forks a repository. For more information, see "Fork a repo." For information about the API to manage forks, see "Forks" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Disponibilidade para fork
- Enterprises
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para fork
Nome, Tipo, Descrição |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
forkee object ObrigatórioThe created |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
github_app_authorization
This event occurs when a user revokes their authorization of a GitHub App. For more information, see "About apps." For information about the API to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
A GitHub App receives this webhook by default and cannot unsubscribe from this event.
Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials
error. For details about requests with a user access token, which require GitHub App authorization, see "Authenticating with a GitHub App on behalf of a user."
Disponibilidade para github_app_authorization
- Aplicativos GitHub
Objeto da carga do webhook para github_app_authorization
Someone revoked their authorization of a GitHub App.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
sender object ObrigatórioA 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.
Disponibilidade para gollum
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para gollum
Nome, Tipo, Descrição |
---|
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 ObrigatórioThe pages that were updated. |
Properties of |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
installation
This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
Disponibilidade para installation
- Aplicativos GitHub
Objeto da carga do webhook para installation
Someone installed a GitHub App on a user or organization account.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ObrigatórioInstallation |
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 ObrigatórioA GitHub user. |
installation_repositories
This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
Disponibilidade para installation_repositories
- Aplicativos GitHub
Objeto da carga do webhook para installation_repositories
A GitHub App installation was granted access to one or more repositories.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ObrigatórioInstallation |
organization object A GitHub organization. Webhook payloads contain the |
repositories_added array of objects ObrigatórioAn array of repository objects, which were added to the installation. |
Properties of |
repositories_removed array of objects ObrigatórioAn 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 ObrigatórioDescribe whether all repositories have been selected or there's a selection involved Pode ser um dos: |
requester object or null Obrigatório |
Properties of |
sender object ObrigatórioA GitHub user. |
installation_target
This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "About apps." For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or "Apps" in the REST API documentation.
Disponibilidade para installation_target
- Aplicativos GitHub
Objeto da carga do webhook para installation_target
Somebody renamed the user or organization account that a GitHub App is installed on.
Nome, Tipo, Descrição |
---|
account object Obrigatório |
Properties of |
action string ObrigatórioValor: |
changes object Obrigatório |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ObrigatórioThe 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 A GitHub user. |
target_type string Obrigatório |
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.
Disponibilidade para issue_comment
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para issue_comment
A comment on an issue or pull request was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
comment object ObrigatórioThe 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 ObrigatórioThe issue the comment belongs to. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
issues
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
Disponibilidade para issues
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para issues
An issue was assigned to a user.
Nome, Tipo, Descrição |
---|
action string ObrigatórioThe 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 ObrigatórioThe issue itself. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
label
This event occurs when there is activity relating to labels. For more information, see "Managing labels." For information about the APIs to manage labels, see the GraphQL documentation or "Labels" in the REST API documentation.
If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled
or unlabeled
action type for the issues
, pull_request
, or discussion
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Disponibilidade para label
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para label
A label was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
label object Obrigatório |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object A GitHub user. |
member
This event occurs when there is activity relating to collaborators in a repository. For more information, see "Adding outside collaborators to repositories in your organization." For more information about the API to manage repository collaborators, see the GraphQL API documentation or "Collaborators" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Disponibilidade para member
- Enterprises
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para member
A GitHub user accepted an invitation to a repository.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 Obrigatório |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
membership
This event occurs when there is activity relating to team membership. For more information, see "About teams." For more information about the APIs to manage team memberships, see the GraphQL API documentation or "Team members" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Disponibilidade para membership
- Organizações
- Enterprises
- Aplicativos GitHub
Objeto da carga do webhook para membership
An organization member was added to a team.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
member object or null Obrigatório |
Properties of |
organization object ObrigatórioA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
scope string ObrigatórioThe scope of the membership. Currently, can only be Valor: |
sender object or null Obrigatório |
team object ObrigatórioGroups 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.
Disponibilidade para meta
- GitHub Marketplace
- Enterprises
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para meta
The webhook was deleted.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
hook object ObrigatórioThe 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 ObrigatórioThe 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 A GitHub user. |
milestone
This event occurs when there is activity relating to milestones. For more information, see "About milestones." For information about the APIs to manage milestones, see the GraphQL documentation or "Milestones" in the REST API documentation.
If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned
or demilestoned
action type for the issues
or pull_request
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.
Disponibilidade para milestone
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para milestone
A milestone was closed.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
milestone object ObrigatórioA collection of related issues and pull requests. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
organization
This event occurs when there is activity relating to an organization and its members. For more information, see "About organizations." For information about the APIs to manage organizations, see the GraphQL documentation or "Organizations" in the REST API documentation.
If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block
event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
Disponibilidade para organization
- Organizações
- Enterprises
- Aplicativos GitHub
Objeto da carga do webhook para organization
An organization was deleted.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
package
This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or "Packages" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.
Disponibilidade para package
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para package
A package was published to a registry.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioInformation about the package. |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA 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.
Disponibilidade para page_build
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para page_build
Nome, Tipo, Descrição |
---|
build object ObrigatórioThe List GitHub Pages builds itself. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
id integer Obrigatório |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
personal_access_token_request
This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "Creating a personal access token."
To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission.
Note
Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.
Disponibilidade para personal_access_token_request
- Aplicativos GitHub
Objeto da carga do webhook para personal_access_token_request
A fine-grained personal access token request was approved.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
personal_access_token_request object ObrigatórioDetails of a Personal Access Token Request. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
organization object ObrigatórioA GitHub organization. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
installation object ObrigatórioThe GitHub App installation. Webhook payloads contain the |
ping
This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.
Disponibilidade para ping
- Repositórios
- Organizações
- Aplicativos GitHub
- Enterprises
- GitHub Marketplace
Objeto da carga do webhook para ping
Nome, Tipo, Descrição |
---|
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 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, 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.
Disponibilidade para project_card
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para project_card
A note in a project (classic) was converted to an issue.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
changes object Obrigatório |
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 Obrigatório |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA 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, 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.
Disponibilidade para project
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para project
A project (classic) was closed.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 Obrigatório |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA 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, 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.
Disponibilidade para project_column
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para project_column
A column was added to a project (classic).
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 Obrigatório |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object A GitHub user. |
projects_v2
This event occurs when there is activity relating to an organization-level project. For more information, see "About Projects." For information about the Projects API, see the GraphQL documentation.
For activity relating to a item on a project, use the projects_v2_item
event. For activity relating to Projects (classic), use the project
, project_card
, and project_column
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
Note
Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
Disponibilidade para projects_v2
- Organizações
Objeto da carga do webhook para projects_v2
A project in the organization was closed.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
installation object The GitHub App installation. Webhook payloads contain the |
organization object ObrigatórioA GitHub organization. Webhook payloads contain the |
projects_v2 object ObrigatórioA projects v2 project |
Properties of |
sender object ObrigatórioA GitHub user. |
projects_v2_item
This event occurs when there is activity relating to an item on an organization-level project. For more information, see "About Projects." For information about the Projects API, see the GraphQL documentation.
For activity relating to a project (instead of an item on a project), use the projects_v2
event. For activity relating to Projects (classic), use the project
, project_card
, and project_column
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
Note
Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
Disponibilidade para projects_v2_item
- Organizações
Objeto da carga do webhook para projects_v2_item
An item on an organization project was archived. For more information, see "Archiving items from your project."
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
changes object Obrigatório |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object ObrigatórioA GitHub organization. Webhook payloads contain the |
projects_v2_item object ObrigatórioAn item belonging to a project |
Properties of |
sender object ObrigatórioA 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.
Disponibilidade para public
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para public
Nome, Tipo, Descrição |
---|
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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
pull_request
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Disponibilidade para pull_request
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para pull_request
A pull request was assigned to a user.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
assignee object or null Obrigatório |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
number integer ObrigatórioThe pull request number. |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Obrigatório |
Properties of |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
pull_request_review_comment
This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "Commenting on a pull request." For information about the APIs to manage pull request review comments, see the GraphQL API documentation or "Pull request review comments" in the REST API documentation.
For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Disponibilidade para pull_request_review_comment
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para pull_request_review_comment
A comment on a pull request diff was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
comment object ObrigatórioThe 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 Obrigatório |
Properties of |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
pull_request_review
This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "About pull request reviews." For information about the APIs to manage pull request reviews, see the GraphQL API documentation or "Pull request reviews" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment
, issue_comment
, or pull_request_review_thread
events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.
Disponibilidade para pull_request_review
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para pull_request_review
A review on a pull request was dismissed.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 Obrigatório |
Properties of |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
review object ObrigatórioThe review that was affected. |
Properties of |
sender object ObrigatórioA 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, 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.
Disponibilidade para pull_request_review_thread
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para pull_request_review_thread
A comment thread on a pull request was marked as resolved.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 Obrigatório |
Properties of |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object A GitHub user. |
thread object Obrigatório |
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.
Disponibilidade para push
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para push
Nome, Tipo, Descrição |
---|
after string ObrigatórioThe SHA of the most recent commit on |
base_ref string or null Obrigatório |
before string ObrigatórioThe SHA of the most recent commit on |
commits array of objects ObrigatórioAn array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the |
Properties of |
compare string ObrigatórioURL that shows the changes in this |
created boolean ObrigatórioWhether this push created the |
deleted boolean ObrigatórioWhether this push deleted the |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
forced boolean ObrigatórioWhether this push was a force push of the |
head_commit object or null Obrigatório |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pusher object ObrigatórioMetaproperties for Git author/committer information. |
Properties of |
ref string ObrigatórioThe full git ref that was pushed. Example: |
repository object ObrigatórioA git repository |
sender object A GitHub user. |
registry_package
This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or "Packages" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.
Note
GitHub recommends that you use the newer package
event instead.
Disponibilidade para registry_package
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para registry_package
A package was published to a registry.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 Obrigatório |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
release
This event occurs when there is activity relating to releases. For more information, see "About releases." For information about the APIs to manage releases, see the GraphQL API documentation or "Releases" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Disponibilidade para release
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para release
A draft was saved, or a release or pre-release was published without previously being saved as a draft.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioThe release object. |
Properties of |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
repository
This event occurs when there is activity relating to repositories. For more information, see "About repositories." For information about the APIs to manage repositories, see the GraphQL documentation or "Repositories" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
Disponibilidade para repository
- Aplicativos GitHub
- Enterprises
- Organizações
- Repositórios
Objeto da carga do webhook para repository
Someone disabled anonymous Git read access to the repository. For more information, see "Enabling anonymous Git read access for a repository."
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 A GitHub user. |
repository_dispatch
This event occurs when a GitHub App sends a POST
request to /repos/{owner}/{repo}/dispatches
. For more information, see the REST API documentation for creating a repository dispatch event. 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.
Disponibilidade para repository_dispatch
- Aplicativos GitHub
Objeto da carga do webhook para repository_dispatch
Nome, Tipo, Descrição |
---|
action string ObrigatórioThe |
branch string Obrigatório |
client_payload object or null ObrigatórioThe |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ObrigatórioThe GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
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, see Repository 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.
Disponibilidade para repository_ruleset
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para repository_ruleset
A repository ruleset was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 |
repository_ruleset object ObrigatórioA set of rules to apply when specified conditions are met. |
Properties of |
sender object ObrigatórioA GitHub user. |
repository_vulnerability_alert
This event occurs when there is activity relating to a security vulnerability alert in a repository.
Warning
Closing down notice: This event is closing down. Use the dependabot_alert
event instead.
Disponibilidade para repository_vulnerability_alert
- Repositórios
- Organizações
Objeto da carga do webhook para repository_vulnerability_alert
A repository vulnerability alert was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
alert object ObrigatórioThe 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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
secret_scanning_alert
This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.
For activity relating to secret scanning alert locations, use the secret_scanning_alert_location
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
Disponibilidade para secret_scanning_alert
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para secret_scanning_alert
A secret scanning alert was created.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
alert object Obrigatório |
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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object A GitHub user. |
secret_scanning_alert_location
This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.
For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.
For activity relating to secret scanning alerts, use the secret_scanning_alert
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
Disponibilidade para secret_scanning_alert_location
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do 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.
Nome, Tipo, Descrição |
---|
action string Valor: |
alert object Obrigatório |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
location object Obrigatório |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA 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, 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."
Disponibilidade para security_advisory
- Aplicativos GitHub
Objeto da carga do webhook para security_advisory
A security advisory was published to the GitHub community.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioThe details of the security advisory, including summary, description, and severity. |
Properties of |
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.
Disponibilidade para security_and_analysis
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para security_and_analysis
Nome, Tipo, Descrição |
---|
changes object Obrigatório |
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 ObrigatórioFull Repository |
sender object A GitHub user. |
sponsorship
This event occurs when there is activity relating to a sponsorship listing. For more information, see "About GitHub Sponsors." For information about the API to manage sponsors, see the GraphQL documentation.
You can only create a sponsorship webhook on GitHub.com. For more information, see "Configuring webhooks for events in your sponsored account."
Disponibilidade para sponsorship
- Contas patrocinadas
Objeto da carga do 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.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioA GitHub user. |
sponsorship object Obrigatório |
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.
Disponibilidade para star
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para star
Someone starred a repository.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
starred_at string or null ObrigatórioThe 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.
Disponibilidade para status
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para status
Nome, Tipo, Descrição |
---|
avatar_url string or null |
branches array of objects ObrigatórioAn 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 Obrigatório |
Properties of |
context string Obrigatório |
created_at string Obrigatório |
description string or null ObrigatórioThe optional human-readable description added to the status. |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
id integer ObrigatórioThe unique identifier of the status. |
installation object The GitHub App installation. Webhook payloads contain the |
name string Obrigatório |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
sha string ObrigatórioThe Commit SHA. |
state string ObrigatórioThe new state. Can be Pode ser um dos: |
target_url string or null ObrigatórioThe optional link added to the status. |
updated_at string Obrigatório |
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.
Disponibilidade para team_add
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para team_add
Nome, Tipo, Descrição |
---|
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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
team object ObrigatórioGroups 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.
Disponibilidade para team
- Organizações
- Enterprises
- Aplicativos GitHub
Objeto da carga do webhook para team
A team was granted access to a repository.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object ObrigatórioA GitHub organization. Webhook payloads contain the |
repository object A git repository |
sender object A GitHub user. |
team object ObrigatórioGroups 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.
Disponibilidade para user
- Enterprises
Objeto da carga do webhook para user
A user account was added to the enterprise.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 A GitHub user. |
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.
Disponibilidade para watch
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do webhook para watch
Someone started watching the repository.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
workflow_dispatch
This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "Manually running a workflow."
For activity relating to workflow runs, use the workflow_run
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
Disponibilidade para workflow_dispatch
- Aplicativos GitHub
Objeto da carga do webhook para workflow_dispatch
Nome, Tipo, Descrição |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
inputs object or null Obrigatório |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
ref string Obrigatório |
repository object ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
workflow string Obrigatório |
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.
Disponibilidade para workflow_job
- Enterprises
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do 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.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
workflow_job object Obrigatório |
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.
Disponibilidade para workflow_run
- Enterprises
- Repositórios
- Organizações
- Aplicativos GitHub
Objeto da carga do 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.
Nome, Tipo, Descrição |
---|
action string ObrigatórioValor: |
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 ObrigatórioThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObrigatórioA GitHub user. |
workflow object or null Obrigatório |
Properties of |
workflow_run object Obrigatório |
Properties of |