Informationen zu Webhook-Ereignissen und -Nutzdaten
Du kannst Webhooks erstellen, die die auf dieser Seite aufgeführten Ereignisse abonnieren. Um die Anzahl von HTTP-Anforderungen an deinen Server zu begrenzen, solltest du nur die spezifischen Ereignisse abonnieren, die du behandeln möchtest. Weitere Informationen findest du unter Erstellen von Webhooks.
Jedes Webhook-Ereignis auf dieser Seite enthält eine Beschreibung der Webhook-Eigenschaften für dieses Ereignis. Wenn das Ereignis über mehrfache Aktionen verfügt, sind die den einzelnen Aktionen entsprechenden Eigenschaften enthalten.
Jedes Ereignis ist nur für bestimmte Webhook-Typen verfügbar. Beispielsweise kann ein team
-Ereignis von einem Organisations-Webhook abonniert werden, nicht aber von einem Repository-Webhook. In der Beschreibung jedes Webhook-Ereignisses wird die Verfügbarkeit für dieses Ereignis angegeben. Weitere Informationen findest du unter Arten von Webhooks.
Nutzdatenobergrenze
Nutzdaten sind auf 25 MB begrenzt. Wenn ein Ereignis eine größere Nutzdatenmenge generiert, übermittelt GitHub keine Nutzdaten für dieses Webhook-Ereignis. Dies kann beispielsweise bei einem create
-Ereignis geschehen, wenn viele Branches oder Tags gleichzeitig verschoben werden. Es wird empfohlen, die Nutzlastgröße zu überwachen, um die Übermittlung sicherzustellen.
Übermittlungsheader
HTTP-POST-Nutzlasten, die an den konfigurierten URL-Endpunkt deines Webhook übermittelt werden, enthalten mehrere spezielle Header:
X-GitHub-Hook-ID
: Der eindeutige Bezeichner des Webhook.X-GitHub-Event
: Der Name des Ereignisses, das die Zustellung ausgelöst hat.X-GitHub-Delivery
: Ein Globally Unique Identifier (GUID), um den Event zu identifizieren.X-GitHub-Enterprise-Version
: Die Version der GitHub Enterprise Server-Instanz, die die HTTP-POST-Nutzdaten gesendet hatX-GitHub-Enterprise-Host
: Der Hostname der GitHub Enterprise Server-Instanz, die die HTTP-POST-Nutzdaten gesendet hatX-Hub-Signature
: Dieser Header wird gesendet, wenn der Webhook mitsecret
konfiguriert ist. Dies ist der HMAC-Hex-Digest des Anforderungstexts und wird mithilfe der SHA-1-Hashfunktion und dessecret
als HMACkey
generiert.X-Hub-Signature
wird aus Gründen der Kompatibilität mit bestehenden Integrationen bereitgestellt. Wir empfehlen, stattdessen die sicherereX-Hub-Signature-256
zu verwenden.X-Hub-Signature-256
: Dieser Header wird gesendet, wenn der Webhook mitsecret
konfiguriert ist. Dies ist der HMAC-Hex-Digest des Anforderungstexts und wird mithilfe der SHA-256-Hashfunktion und dessecret
als HMACkey
generiert. Weitere Informationen findest du unter Validierung von Webhook-Zustellung.User-Agent
: Dieser Header hat immer das PräfixGitHub-Hookshot/
.X-GitHub-Hook-Installation-Target-Type
: Der Typ der Ressource, in der der Webhook erstellt wurde.X-GitHub-Hook-Installation-Target-ID
: Der eindeutige Bezeichner der Ressource, in der der Webhook erstellt wurde.
Informationen dazu, wie jeder Header in Webhook-Nutzdaten aussehen kann, finden Sie unter „Beispiel für die Webhook-Zustellung“.
Beispiel für die Webhook-Zustellung
Sie können auswählen, ob Nutzdaten im JSON-Format (application/json
) oder als URL-codierte Daten (x-www-form-urlencoded
) zugestellt werden sollen. Nachfolgend sehen Sie ein Beispiel für eine-WEBhook POST-Anforderung im JSON-Format.
> POST /payload HTTP/2
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
> X-GitHub-Enterprise-Version: 2.15.0
> X-GitHub-Enterprise-Host: example.com
> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c
> User-Agent: GitHub-Hookshot/044aadd
> Content-Type: application/json
> Content-Length: 6615
> X-GitHub-Event: issues
> X-GitHub-Hook-ID: 292430182
> X-GitHub-Hook-Installation-Target-ID: 79929171
> X-GitHub-Hook-Installation-Target-Type: repository
> {
> "action": "opened",
> "issue": {
> "url": "http(s)://HOSTNAME/api/v3/repos/octocat/Hello-World/issues/1347",
> "number": 1347,
> ...
> },
> "repository" : {
> "id": 1296269,
> "full_name": "octocat/Hello-World",
> "owner": {
> "login": "octocat",
> "id": 1,
> ...
> },
> ...
> },
> "sender": {
> "login": "octocat",
> "id": 1,
> ...
> }
> }
branch_protection_rule
This event occurs when there is activity relating to branch protection rules. For more information, see "About protected branches." For information about the APIs to manage branch protection rules, see the GraphQL documentation or "Branch protection" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.
Verfügbarkeit für branch_protection_rule
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für branch_protection_rule
A branch protection rule was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
rule object ErforderlichThe branch protection rule. Includes a |
Properties of |
sender object ErforderlichA 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."
Verfügbarkeit für cache_sync
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für cache_sync
Name, type, BESCHREIBUNG |
---|
after string Erforderlich |
before string Erforderlich |
cache_location string Erforderlich |
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 Erforderlich |
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
.
Verfügbarkeit für check_run
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für check_run
A check run was completed, and a conclusion is available.
Name, type, BESCHREIBUNG |
---|
action string Wert: |
check_run object ErforderlichA 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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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
.
Verfügbarkeit für check_suite
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für check_suite
All check runs in a check suite have completed, and a conclusion is available.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
check_suite object ErforderlichThe 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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für code_scanning_alert
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für 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.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
alert object ErforderlichThe code scanning alert involved in the event. |
Properties of |
commit_oid string ErforderlichThe 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 ErforderlichThe Git reference of the code scanning alert. When the action is |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für commit_comment
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für commit_comment
Someone commented on a commit.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichThe action performed. Can be Wert: |
comment object ErforderlichThe 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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für create
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für create
Name, type, BESCHREIBUNG |
---|
description string or null ErforderlichThe 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 ErforderlichThe name of the repository's default branch (usually |
organization object A GitHub organization. Webhook payloads contain the |
pusher_type string ErforderlichThe pusher type for the event. Can be either |
ref string ErforderlichThe |
ref_type string ErforderlichThe type of Git ref object created in the repository. Kann eine der Folgenden sein: |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für delete
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für delete
Name, type, BESCHREIBUNG |
---|
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 ErforderlichThe pusher type for the event. Can be either |
ref string ErforderlichThe |
ref_type string ErforderlichThe type of Git ref object deleted in the repository. Kann eine der Folgenden sein: |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für dependabot_alert
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für dependabot_alert
A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
alert object ErforderlichA 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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für deploy_key
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für deploy_key
A deploy key was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
key object ErforderlichThe |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für deployment
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für deployment
A deployment was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
deployment object ErforderlichThe 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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA GitHub user. |
workflow object or null Erforderlich |
Properties of |
workflow_run object or null Erforderlich |
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.
Verfügbarkeit für deployment_protection_rule
- GitHub Apps
Webhooknutzlastobjekt für deployment_protection_rule
A deployment protection rule was requested for an environment.
Name, type, BESCHREIBUNG |
---|
action string Wert: |
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.
Verfügbarkeit für deployment_review
- GitHub Apps
Webhooknutzlastobjekt für deployment_review
A deployment review was approved.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichA GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
reviewers array of objects |
Properties of |
sender object ErforderlichA GitHub user. |
since string Erforderlich |
workflow_job_run object |
Properties of |
workflow_job_runs array of objects |
Properties of |
workflow_run object or null Erforderlich |
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.
Verfügbarkeit für deployment_status
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für deployment_status
A new deployment status was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
check_run object or null |
Properties of |
deployment object ErforderlichThe deployment. |
Properties of |
deployment_status object ErforderlichThe 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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für discussion
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für discussion
A comment on the discussion was marked as the answer.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
answer object Erforderlich |
Properties of |
discussion object ErforderlichA 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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für discussion_comment
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für discussion_comment
A comment on a discussion was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
comment object Erforderlich |
Properties of |
discussion object ErforderlichA 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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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."
Verfügbarkeit für enterprise
- Unternehmen
Webhooknutzlastobjekt für enterprise
Anonymous Git read access was disabled.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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.
Verfügbarkeit für fork
- Unternehmen
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für fork
Name, type, BESCHREIBUNG |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
forkee object ErforderlichThe created |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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."
Verfügbarkeit für github_app_authorization
- GitHub Apps
Webhooknutzlastobjekt für github_app_authorization
Someone revoked their authorization of a GitHub App.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
sender object ErforderlichA 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.
Verfügbarkeit für gollum
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für gollum
Name, type, BESCHREIBUNG |
---|
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 ErforderlichThe pages that were updated. |
Properties of |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für installation
- GitHub Apps
Webhooknutzlastobjekt für installation
Someone installed a GitHub App on a user or organization account.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ErforderlichInstallation |
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 ErforderlichA 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.
Verfügbarkeit für installation_repositories
- GitHub Apps
Webhooknutzlastobjekt für installation_repositories
A GitHub App installation was granted access to one or more repositories.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ErforderlichInstallation |
organization object A GitHub organization. Webhook payloads contain the |
repositories_added array of objects ErforderlichAn array of repository objects, which were added to the installation. |
Properties of |
repositories_removed array of objects ErforderlichAn 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 ErforderlichDescribe whether all repositories have been selected or there's a selection involved Kann eine der Folgenden sein: |
requester object or null Erforderlich |
Properties of |
sender object ErforderlichA 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.
Verfügbarkeit für installation_target
- GitHub Apps
Webhooknutzlastobjekt für installation_target
Somebody renamed the user or organization account that a GitHub App is installed on.
Name, type, BESCHREIBUNG |
---|
account object Erforderlich |
Properties of |
action string ErforderlichWert: |
changes object Erforderlich |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ErforderlichThe 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 Erforderlich |
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.
Verfügbarkeit für issue_comment
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für issue_comment
A comment on an issue or pull request was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
comment object ErforderlichThe 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 ErforderlichThe issue the comment belongs to. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für issues
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für issues
An issue was assigned to a user.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichThe action that was performed. Wert: |
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 ErforderlichThe issue itself. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für label
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für label
A label was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
label object Erforderlich |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe 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.
Verfügbarkeit für member
- Unternehmen
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für member
A GitHub user accepted an invitation to a repository.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 Erforderlich |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für membership
- Organisationen
- Unternehmen
- GitHub Apps
Webhooknutzlastobjekt für membership
An organization member was added to a team.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
member object or null Erforderlich |
Properties of |
organization object ErforderlichA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
scope string ErforderlichThe scope of the membership. Currently, can only be Wert: |
sender object or null Erforderlich |
team object ErforderlichGroups 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.
Verfügbarkeit für meta
- GitHub Marketplace
- Unternehmen
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für meta
The webhook was deleted.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
hook object ErforderlichThe 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 ErforderlichThe 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.
Verfügbarkeit für milestone
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für milestone
A milestone was closed.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
milestone object ErforderlichA collection of related issues and pull requests. |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für organization
- Organisationen
- Unternehmen
- GitHub Apps
Webhooknutzlastobjekt für organization
An organization was deleted.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichA GitHub organization. Webhook payloads contain the |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für package
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für package
A package was published to a registry.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichInformation about the package. |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für page_build
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für page_build
Name, type, BESCHREIBUNG |
---|
build object ErforderlichThe List GitHub Pages builds itself. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
id integer Erforderlich |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für personal_access_token_request
- GitHub Apps
Webhooknutzlastobjekt für personal_access_token_request
A fine-grained personal access token request was approved.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
personal_access_token_request object ErforderlichDetails of a Personal Access Token Request. |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
organization object ErforderlichA GitHub organization. Webhook payloads contain the |
sender object ErforderlichA GitHub user. |
installation object ErforderlichThe 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.
Verfügbarkeit für ping
- Repositorys
- Organisationen
- GitHub Apps
- Unternehmen
- GitHub Marketplace
Webhooknutzlastobjekt für ping
Name, type, BESCHREIBUNG |
---|
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.
Verfügbarkeit für project_card
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für project_card
A note in a project (classic) was converted to an issue.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
changes object Erforderlich |
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 Erforderlich |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für project
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für project
A project (classic) was closed.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 Erforderlich |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für project_column
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für project_column
A column was added to a project (classic).
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 Erforderlich |
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.
Verfügbarkeit für projects_v2
- Organisationen
Webhooknutzlastobjekt für projects_v2
A project in the organization was closed.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
installation object The GitHub App installation. Webhook payloads contain the |
organization object ErforderlichA GitHub organization. Webhook payloads contain the |
projects_v2 object ErforderlichA projects v2 project |
Properties of |
sender object ErforderlichA 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.
Verfügbarkeit für projects_v2_item
- Organisationen
Webhooknutzlastobjekt für projects_v2_item
An item on an organization project was archived. For more information, see "Archiving items from your project."
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
changes object Erforderlich |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object ErforderlichA GitHub organization. Webhook payloads contain the |
projects_v2_item object ErforderlichAn item belonging to a project |
Properties of |
sender object ErforderlichA 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.
Verfügbarkeit für public
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für public
Name, type, BESCHREIBUNG |
---|
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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für pull_request
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für pull_request
A pull request was assigned to a user.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
assignee object or null Erforderlich |
Properties of |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
number integer ErforderlichThe pull request number. |
organization object A GitHub organization. Webhook payloads contain the |
pull_request object Erforderlich |
Properties of |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für pull_request_review_comment
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für pull_request_review_comment
A comment on a pull request diff was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
comment object ErforderlichThe 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 Erforderlich |
Properties of |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für pull_request_review
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für pull_request_review
A review on a pull request was dismissed.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 Erforderlich |
Properties of |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
review object ErforderlichThe review that was affected. |
Properties of |
sender object ErforderlichA 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.
Verfügbarkeit für pull_request_review_thread
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für pull_request_review_thread
A comment thread on a pull request was marked as resolved.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 Erforderlich |
Properties of |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object A GitHub user. |
thread object Erforderlich |
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.
Verfügbarkeit für push
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für push
Name, type, BESCHREIBUNG |
---|
after string ErforderlichThe SHA of the most recent commit on |
base_ref string or null Erforderlich |
before string ErforderlichThe SHA of the most recent commit on |
commits array of objects ErforderlichAn array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the |
Properties of |
compare string ErforderlichURL that shows the changes in this |
created boolean ErforderlichWhether this push created the |
deleted boolean ErforderlichWhether this push deleted the |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
forced boolean ErforderlichWhether this push was a force push of the |
head_commit object or null Erforderlich |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
pusher object ErforderlichMetaproperties for Git author/committer information. |
Properties of |
ref string ErforderlichThe full git ref that was pushed. Example: |
repository object ErforderlichA 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.
Verfügbarkeit für registry_package
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für registry_package
A package was published to a registry.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 Erforderlich |
Properties of |
repository object The repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für release
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für release
A draft was saved, or a release or pre-release was published without previously being saved as a draft.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichThe release object. |
Properties of |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für repository
- GitHub Apps
- Unternehmen
- Organisationen
- Repositorys
Webhooknutzlastobjekt für repository
Someone disabled anonymous Git read access to the repository. For more information, see "Enabling anonymous Git read access for a repository."
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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.
Verfügbarkeit für repository_dispatch
- GitHub Apps
Webhooknutzlastobjekt für repository_dispatch
Name, type, BESCHREIBUNG |
---|
action string ErforderlichThe |
branch string Erforderlich |
client_payload object or null ErforderlichThe |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object ErforderlichThe GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für repository_vulnerability_alert
- Repositorys
- Organisationen
Webhooknutzlastobjekt für repository_vulnerability_alert
A repository vulnerability alert was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
alert object ErforderlichThe 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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für secret_scanning_alert
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für secret_scanning_alert
A secret scanning alert was created.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
alert object Erforderlich |
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 ErforderlichThe 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.
Verfügbarkeit für secret_scanning_alert_location
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für 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.
Name, type, BESCHREIBUNG |
---|
action string Wert: |
alert object Erforderlich |
Properties of |
installation object The GitHub App installation. Webhook payloads contain the |
location object Erforderlich |
Properties of |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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."
Verfügbarkeit für security_advisory
- GitHub Apps
Webhooknutzlastobjekt für security_advisory
A security advisory was published to the GitHub community.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichThe 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.
Verfügbarkeit für security_and_analysis
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für security_and_analysis
Name, type, BESCHREIBUNG |
---|
changes object Erforderlich |
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 ErforderlichFull 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."
Verfügbarkeit für sponsorship
- Gesponserte Konten
Webhooknutzlastobjekt für 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.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichA GitHub user. |
sponsorship object Erforderlich |
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.
Verfügbarkeit für star
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für star
Someone starred a repository.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA GitHub user. |
starred_at string or null ErforderlichThe 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.
Verfügbarkeit für status
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für status
Name, type, BESCHREIBUNG |
---|
avatar_url string or null |
branches array of objects ErforderlichAn 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 Erforderlich |
Properties of |
context string Erforderlich |
created_at string Erforderlich |
description string or null ErforderlichThe optional human-readable description added to the status. |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
id integer ErforderlichThe unique identifier of the status. |
installation object The GitHub App installation. Webhook payloads contain the |
name string Erforderlich |
organization object A GitHub organization. Webhook payloads contain the |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA GitHub user. |
sha string ErforderlichThe Commit SHA. |
state string ErforderlichThe new state. Can be Kann eine der Folgenden sein: |
target_url string or null ErforderlichThe optional link added to the status. |
updated_at string Erforderlich |
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.
Verfügbarkeit für team_add
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für team_add
Name, type, BESCHREIBUNG |
---|
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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA GitHub user. |
team object ErforderlichGroups 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.
Verfügbarkeit für team
- Organisationen
- Unternehmen
- GitHub Apps
Webhooknutzlastobjekt für team
A team was granted access to a repository.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
enterprise object An enterprise on GitHub. Webhook payloads contain the |
installation object The GitHub App installation. Webhook payloads contain the |
organization object ErforderlichA GitHub organization. Webhook payloads contain the |
repository object A git repository |
sender object A GitHub user. |
team object ErforderlichGroups 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.
Verfügbarkeit für user
- Unternehmen
Webhooknutzlastobjekt für user
A user account was added to the enterprise.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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.
Verfügbarkeit für watch
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für watch
Someone started watching the repository.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA 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.
Verfügbarkeit für workflow_dispatch
- GitHub Apps
Webhooknutzlastobjekt für workflow_dispatch
Name, type, BESCHREIBUNG |
---|
enterprise object An enterprise on GitHub. Webhook payloads contain the |
inputs object or null Erforderlich |
installation object The GitHub App installation. Webhook payloads contain the |
organization object A GitHub organization. Webhook payloads contain the |
ref string Erforderlich |
repository object ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA GitHub user. |
workflow string Erforderlich |
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.
Verfügbarkeit für workflow_job
- Unternehmen
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für 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.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA GitHub user. |
workflow_job object Erforderlich |
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.
Verfügbarkeit für workflow_run
- Unternehmen
- Repositorys
- Organisationen
- GitHub Apps
Webhooknutzlastobjekt für workflow_run
A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
Name, type, BESCHREIBUNG |
---|
action string ErforderlichWert: |
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 ErforderlichThe repository on GitHub where the event occurred. Webhook payloads contain the |
sender object ErforderlichA GitHub user. |
workflow object or null Erforderlich |
Properties of |
workflow_run object Erforderlich |
Properties of |