Informations sur des événements et des charges utiles des webhooks
Vous pouvez créer des webhooks qui s’abonnent aux événements listés dans cette page. Pour limiter le nombre de requêtes HTTP sur votre serveur, vous devez vous abonner uniquement aux événements spécifiques que vous prévoyez de gérer. Pour plus d’informations, consultez « Création de webhooks ».
Chaque événement de webhook de cette page comprend une description des propriétés du webhook pour cet événement. Si l'événement a plusieurs actions, les propriétés correspondant à chaque action sont incluses.
Chaque événement est disponible uniquement pour des types spécifiques de webhooks. Par exemple, un webhook d’organisation peut s’abonner à l’événement team
, mais un webhook de référentiel ne peut pas. La description de chaque événement webhook répertorie la disponibilité de cet événement. Pour plus d’informations, consultez « Types de webhook ».
Limite de charge utile
Les charges utiles sont limitées à 25 Mo. Si un événement génère une charge utile plus grande, GitHub ne fournira pas de charge utile pour cet événement webhook. Cela peut se produire, par exemple, sur un événement create
si de nombreuses branches ou étiquettes sont poussées à la fois. Nous vous suggérons de monitorer la taille de votre charge utile pour garantir la livraison.
En-têtes de livraison
Les charges utiles HTTP POST livrées au point de terminaison de l’URL configurée de votre webhook contiennent plusieurs en-têtes spéciaux :
X-GitHub-Hook-ID
: identificateur unique du webhook.X-GitHub-Event
: nom de l’événement qui a déclenché la livraison.X-GitHub-Delivery
: Un identificateur global unique (GUID) pour identifier l’événement.X-GitHub-Enterprise-Version
: version de l’instance GitHub Enterprise Server qui a envoyé la charge utile HTTP POST.X-GitHub-Enterprise-Host
: nom d’hôte de l’instance GitHub Enterprise Server qui a envoyé la charge utile HTTP POST.X-Hub-Signature
: cet en-tête est envoyé si le webhook est configuré avec unsecret
. Il s’agit de la synthèse hexadécimale HMAC du corps de la demande, qui est générée avec la fonction de hachage SHA-1 et dont lesecret
est lakey
HMAC.X-Hub-Signature
est fourni pour assurer la compatibilité avec les intégrations existantes. Nous vous recommandons d’utiliser plutôt la versionX-Hub-Signature-256
plus sécurisée.X-Hub-Signature-256
: cet en-tête est envoyé si le webhook est configuré avec unsecret
. Il s’agit du code de hachage hexadécimal HMAC du corps de la demande, qui est généré avec la fonction de hachage SHA-256 et dont lesecret
est lakey
HMAC. Pour plus d’informations, consultez « Validation des livraisons de webhook ».User-Agent
: Cet en-tête aura toujours le préfixeGitHub-Hookshot/
.X-GitHub-Hook-Installation-Target-Type
: type de la ressource dans laquelle le webhook a été créé.X-GitHub-Hook-Installation-Target-ID
: identificateur unique de la ressource dans laquelle le webhook a été créé.
Pour voir à quoi chaque en-tête peut ressembler dans une charge utile de webhook, consultez « Exemple de livraison de webhook ».
Exemple de livraison de webhook
Vous pouvez choisir de recevoir les charges utiles au format JSON (application/json
) ou sous forme de données encodées en URL (x-www-form-urlencoded
). Voici un exemple de demande POST de webhook qui utilise le format 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.
Disponibilité pour branch_protection_configuration
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour branch_protection_configuration
All branch protections were disabled for a repository.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilité pour branch_protection_rule
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour branch_protection_rule
A branch protection rule was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
rule object ObligatoireThe branch protection rule. Includes a |
Properties of |
sender object ObligatoireThe 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."
Disponibilité pour cache_sync
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour cache_sync
Nom, Type, Description |
---|
after string Obligatoire |
before string Obligatoire |
cache_location string Obligatoire |
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 Obligatoire |
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
.
Disponibilité pour check_run
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour check_run
A check run was completed, and a conclusion is available.
Nom, Type, Description |
---|
action string Value: |
check_run object ObligatoireA 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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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
.
Disponibilité pour check_suite
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour check_suite
All check runs in a check suite have completed, and a conclusion is available.
Nom, Type, Description |
---|
action string ObligatoireValue: |
check_suite object ObligatoireThe 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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour code_scanning_alert
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour 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.
Nom, Type, Description |
---|
action string ObligatoireValue: |
alert object ObligatoireThe code scanning alert involved in the event. |
Properties of |
commit_oid string ObligatoireThe 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 ObligatoireThe Git reference of the code scanning alert. When the action is |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour commit_comment
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour commit_comment
Someone commented on a commit.
Nom, Type, Description |
---|
action string ObligatoireThe action performed. Can be Value: |
comment object ObligatoireThe 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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour create
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour create
Nom, Type, Description |
---|
description string or null ObligatoireThe 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 ObligatoireThe name of the repository's default branch (usually |
organization object A GitHub organization. Webhook payloads contain the |
pusher_type string ObligatoireThe pusher type for the event. Can be either |
ref string ObligatoireThe |
ref_type string ObligatoireThe type of Git ref object created in the repository. Peut être: |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour delete
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour delete
Nom, Type, Description |
---|
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 ObligatoireThe pusher type for the event. Can be either |
ref string ObligatoireThe |
ref_type string ObligatoireThe type of Git ref object deleted in the repository. Peut être: |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour dependabot_alert
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour dependabot_alert
A Dependabot alert was automatically closed by a Dependabot auto-triage rule.
Nom, Type, Description |
---|
action string ObligatoireValue: |
alert object ObligatoireA 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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour deploy_key
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour deploy_key
A deploy key was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
key object ObligatoireThe |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour deployment
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour deployment
A deployment was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
deployment object ObligatoireThe 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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow object or null Obligatoire |
Properties of |
workflow_run object or null Obligatoire |
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.
Disponibilité pour deployment_protection_rule
- Applications GitHub
Objet de charge utile de webhook pour deployment_protection_rule
A deployment protection rule was requested for an environment.
Nom, Type, Description |
---|
action string Value: |
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 The GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilité pour deployment_review
- Applications GitHub
Objet de charge utile de webhook pour deployment_review
A deployment review was approved.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireA GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
reviewers array of objects |
Properties of |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
since string Obligatoire |
workflow_job_run object |
Properties of |
workflow_job_runs array of objects |
Properties of |
workflow_run object or null Obligatoire |
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.
Disponibilité pour deployment_status
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour deployment_status
A new deployment status was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
check_run object or null |
Properties of |
deployment object ObligatoireThe deployment. |
Properties of |
deployment_status object ObligatoireThe 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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour discussion
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour discussion
A comment on the discussion was marked as the answer.
Nom, Type, Description |
---|
action string ObligatoireValue: |
answer object Obligatoire |
Properties of |
discussion object ObligatoireA 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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour discussion_comment
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour discussion_comment
A comment on a discussion was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
comment object Obligatoire |
Properties of |
discussion object ObligatoireA 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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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."
Disponibilité pour enterprise
- Entreprises
Objet de charge utile de webhook pour enterprise
Anonymous Git read access was disabled.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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.
Disponibilité pour fork
- Entreprises
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour fork
Nom, Type, Description |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
forkee object ObligatoireThe created |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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."
Disponibilité pour github_app_authorization
- Applications GitHub
Objet de charge utile de webhook pour github_app_authorization
Someone revoked their authorization of a GitHub App.
Nom, Type, Description |
---|
action string ObligatoireValue: |
sender object ObligatoireThe 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.
Disponibilité pour gollum
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour gollum
Nom, Type, Description |
---|
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 ObligatoireThe pages that were updated. |
Properties of |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour installation
- Applications GitHub
Objet de charge utile de webhook pour installation
Someone installed a GitHub App on a user or organization account.
Nom, Type, Description |
---|
action string ObligatoireValue: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ObligatoireInstallation |
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 ObligatoireThe 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.
Disponibilité pour installation_repositories
- Applications GitHub
Objet de charge utile de webhook pour installation_repositories
A GitHub App installation was granted access to one or more repositories.
Nom, Type, Description |
---|
action string ObligatoireValue: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ObligatoireInstallation |
organization object A GitHub organization. Webhook payloads contain the |
repositories_added array of objects ObligatoireAn array of repository objects, which were added to the installation. |
Properties of |
repositories_removed array of objects ObligatoireAn 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 ObligatoireDescribe whether all repositories have been selected or there's a selection involved Peut être: |
requester object or null Obligatoire |
Properties of |
sender object ObligatoireThe 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.
Disponibilité pour installation_target
- Applications GitHub
Objet de charge utile de webhook pour installation_target
Somebody renamed the user or organization account that a GitHub App is installed on.
Nom, Type, Description |
---|
account object Obligatoire |
Properties of |
action string ObligatoireValue: |
changes object Obligatoire |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ObligatoireThe 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 Obligatoire |
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.
Disponibilité pour issue_comment
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour issue_comment
A comment on an issue or pull request was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
comment object ObligatoireThe 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 ObligatoireThe issue the comment belongs to. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour issues
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour issues
An issue was assigned to a user.
Nom, Type, Description |
---|
action string ObligatoireThe action that was performed. Value: |
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 ObligatoireThe issue itself. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour label
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour label
A label was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
label object Obligatoire |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe 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.
Disponibilité pour member
- Entreprises
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour member
A GitHub user accepted an invitation to a repository.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 Obligatoire |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour membership
- Organisations
- Entreprises
- Applications GitHub
Objet de charge utile de webhook pour membership
An organization member was added to a team.
Nom, Type, Description |
---|
action string ObligatoireValue: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
member object or null Obligatoire |
Properties of |
organization object ObligatoireA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
scope string ObligatoireThe scope of the membership. Currently, can only be Value: |
sender object or null Obligatoire |
team object ObligatoireGroups 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.
Disponibilité pour meta
- GitHub Marketplace
- Entreprises
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour meta
The webhook was deleted.
Nom, Type, Description |
---|
action string ObligatoireValue: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
hook object ObligatoireThe 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 ObligatoireThe 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.
Disponibilité pour milestone
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour milestone
A milestone was closed.
Nom, Type, Description |
---|
action string ObligatoireValue: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
milestone object ObligatoireA collection of related issues and pull requests. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour organization
- Organisations
- Entreprises
- Applications GitHub
Objet de charge utile de webhook pour organization
An organization was deleted.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour package
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour package
A package was published to a registry.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireInformation about the package. |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour page_build
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour page_build
Nom, Type, Description |
---|
build object ObligatoireThe List GitHub Pages builds itself. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
id integer Obligatoire |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
personal_access_token_request
This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "Creating a personal access token."
To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission.
Note
Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
Disponibilité pour personal_access_token_request
- Applications GitHub
Objet de charge utile de webhook pour personal_access_token_request
A fine-grained personal access token request was approved.
Nom, Type, Description |
---|
action string ObligatoireValue: |
personal_access_token_request object ObligatoireDetails of a Personal Access Token Request. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
organization object ObligatoireA GitHub organization. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
installation object ObligatoireThe 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.
Disponibilité pour ping
- Référentiels
- Organisations
- Applications GitHub
- Entreprises
- GitHub Marketplace
Objet de charge utile de webhook pour ping
Nom, Type, Description |
---|
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.
Disponibilité pour project_card
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour project_card
A note in a project (classic) was converted to an issue.
Nom, Type, Description |
---|
action string ObligatoireValue: |
changes object Obligatoire |
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 Obligatoire |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour project
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour project
A project (classic) was closed.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 Obligatoire |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour project_column
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour project_column
A column was added to a project (classic).
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 Obligatoire |
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.
Disponibilité pour projects_v2
- Organisations
Objet de charge utile de webhook pour projects_v2
A project in the organization was closed.
Nom, Type, Description |
---|
action string ObligatoireValue: |
installation object The GitHub App installation. Webhook payloads contain the |
organization object ObligatoireA GitHub organization. Webhook payloads contain the |
projects_v2 object ObligatoireA projects v2 project |
Properties of |
sender object ObligatoireThe 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.
Disponibilité pour projects_v2_item
- Organisations
Objet de charge utile de webhook pour projects_v2_item
An item on an organization project was archived. For more information, see "Archiving items from your project."
Nom, Type, Description |
---|
action string ObligatoireValue: |
changes object Obligatoire |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object ObligatoireA GitHub organization. Webhook payloads contain the |
projects_v2_item object ObligatoireAn item belonging to a project |
Properties of |
sender object ObligatoireThe 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.
Disponibilité pour public
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour public
Nom, Type, Description |
---|
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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour pull_request
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour pull_request
A pull request was assigned to a user.
Nom, Type, Description |
---|
action string ObligatoireValue: |
assignee object or null Obligatoire |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
number integer ObligatoireThe pull request number. |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Obligatoire |
Properties of |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour pull_request_review_comment
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour pull_request_review_comment
A comment on a pull request diff was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
comment object ObligatoireThe 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 Obligatoire |
Properties of |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour pull_request_review
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour pull_request_review
A review on a pull request was dismissed.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 Obligatoire |
Properties of |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
review object ObligatoireThe review that was affected. |
Properties of |
sender object ObligatoireThe 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.
Disponibilité pour pull_request_review_thread
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour pull_request_review_thread
A comment thread on a pull request was marked as resolved.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 Obligatoire |
Properties of |
repository object ObligatoireThe 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 Obligatoire |
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.
Disponibilité pour push
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour push
Nom, Type, Description |
---|
after string ObligatoireThe SHA of the most recent commit on |
base_ref string or null Obligatoire |
before string ObligatoireThe SHA of the most recent commit on |
commits array of objects ObligatoireAn array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the |
Properties of |
compare string ObligatoireURL that shows the changes in this |
created boolean ObligatoireWhether this push created the |
deleted boolean ObligatoireWhether this push deleted the |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
forced boolean ObligatoireWhether this push was a force push of the |
head_commit object or null Obligatoire |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pusher object ObligatoireMetaproperties for Git author/committer information. |
Properties of |
ref string ObligatoireThe full git ref that was pushed. Example: |
repository object ObligatoireA 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.
Disponibilité pour registry_package
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour registry_package
A package was published to a registry.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 Obligatoire |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour release
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour release
A draft was saved, or a release or pre-release was published without previously being saved as a draft.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireThe release object. |
Properties of |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour repository
- Applications GitHub
- Entreprises
- Organisations
- Référentiels
Objet de charge utile de webhook pour repository
Someone disabled anonymous Git read access to the repository. For more information, see "Enabling anonymous Git read access for a repository."
Nom, Type, Description |
---|
action string ObligatoireValue: |
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.
Disponibilité pour repository_dispatch
- Applications GitHub
Objet de charge utile de webhook pour repository_dispatch
Nom, Type, Description |
---|
action string ObligatoireThe |
branch string Obligatoire |
client_payload object or null ObligatoireThe |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ObligatoireThe GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
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.
Disponibilité pour repository_ruleset
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour repository_ruleset
A repository ruleset was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireA set of rules to apply when specified conditions are met. |
Properties of |
sender object ObligatoireThe 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.
Warning
Deprecation notice: This event is deprecated. Use the dependabot_alert
event instead.
Disponibilité pour repository_vulnerability_alert
- Référentiels
- Organisations
Objet de charge utile de webhook pour repository_vulnerability_alert
A repository vulnerability alert was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
alert object ObligatoireThe 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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour secret_scanning_alert
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour secret_scanning_alert
A secret scanning alert was created.
Nom, Type, Description |
---|
action string ObligatoireValue: |
alert object Obligatoire |
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 ObligatoireThe 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.
Disponibilité pour secret_scanning_alert_location
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour 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.
Nom, Type, Description |
---|
action string Value: |
alert object Obligatoire |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
location object Obligatoire |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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."
Disponibilité pour security_advisory
- Applications GitHub
Objet de charge utile de webhook pour security_advisory
A security advisory was published to the GitHub community.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireThe 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.
Disponibilité pour security_and_analysis
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour security_and_analysis
Nom, Type, Description |
---|
changes object Obligatoire |
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 ObligatoireFull 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."
Disponibilité pour sponsorship
- Comptes sponsorisés
Objet de charge utile de webhook pour 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.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
sponsorship object Obligatoire |
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.
Disponibilité pour star
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour star
Someone starred a repository.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
starred_at string or null ObligatoireThe 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.
Disponibilité pour status
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour status
Nom, Type, Description |
---|
avatar_url string or null |
branches array of objects ObligatoireAn 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 Obligatoire |
Properties of |
context string Obligatoire |
created_at string Obligatoire |
description string or null ObligatoireThe optional human-readable description added to the status. |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
id integer ObligatoireThe unique identifier of the status. |
installation object The GitHub App installation. Webhook payloads contain the |
name string Obligatoire |
organization object A GitHub organization. Webhook payloads contain the |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
sha string ObligatoireThe Commit SHA. |
state string ObligatoireThe new state. Can be Peut être: |
target_url string or null ObligatoireThe optional link added to the status. |
updated_at string Obligatoire |
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.
Disponibilité pour team_add
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour team_add
Nom, Type, Description |
---|
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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
team object ObligatoireGroups 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.
Disponibilité pour team
- Organisations
- Entreprises
- Applications GitHub
Objet de charge utile de webhook pour team
A team was granted access to a repository.
Nom, Type, Description |
---|
action string ObligatoireValue: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object ObligatoireA 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 ObligatoireGroups 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.
Disponibilité pour user
- Entreprises
Objet de charge utile de webhook pour user
A user account was added to the enterprise.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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.
Disponibilité pour watch
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour watch
Someone started watching the repository.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe 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.
Disponibilité pour workflow_dispatch
- Applications GitHub
Objet de charge utile de webhook pour workflow_dispatch
Nom, Type, Description |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
inputs object or null Obligatoire |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
ref string Obligatoire |
repository object ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow string Obligatoire |
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.
Disponibilité pour workflow_job
- Entreprises
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour 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.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow_job object Obligatoire |
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.
Disponibilité pour workflow_run
- Entreprises
- Référentiels
- Organisations
- Applications GitHub
Objet de charge utile de webhook pour workflow_run
A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
Nom, Type, Description |
---|
action string ObligatoireValue: |
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 ObligatoireThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ObligatoireThe GitHub user that triggered the event. This property is included in every webhook payload. |
workflow object or null Obligatoire |
Properties of |
workflow_run object Obligatoire |
Properties of |