Skip to main content
Wir veröffentlichen regelmäßig Aktualisierungen unserer Dokumentation, und die Übersetzung dieser Seite ist möglicherweise noch nicht abgeschlossen. Aktuelle Informationen findest du in der englischsprachigen Dokumentation.

Webhook-Ereignisse und -Nutzlasten

Hier erfährst du, wann jedes Webhookereignis auftritt und was die Nutzlast enthält.

Unternehmenskonten sind mit GitHub Enterprise Cloud und GitHub Enterprise Server verfügbar. Weitere Informationen findest du unter Informationen zu Unternehmenskonten in der Dokumentation zu GitHub Enterprise Cloud.

Webhooks, die für Unternehmenskonten oder für Organisationen, die einem Unternehmenskonto angehören, konfiguriert sind, umfassen ein enterprise-Kontoobjekt.

Beim Konfigurieren eines Webhooks kannst du die UI oder API verwenden, um auszuwählen, welche Ereignisse dir Nutzlasten senden. Nur das Abonnieren der spezifischen Ereignisse, die du für die Behandlung planst, beschränkt die Anzahl der HTTP-Anforderungen auf deinen Server. Du kannst auch alle aktuellen und zukünftigen Ereignisse abonnieren. Standardmäßig werden Webhooks nur für das Push-Ereignis abonniert. Du kannst die Liste der abonnierten Ereignisse jederzeit ändern.

Du kannst Webhooks erstellen, die die auf dieser Seite aufgeführten Ereignisse abonnieren. Jedes Webhookereignis enthält eine Beschreibung der Webhookeigenschaften und eine Beispielnutzlast. Weitere Informationen findest du unter Erstellen von Webhooks.

Allgemeine Eigenschaften des Webhook-Nutzlastobjekts

Jede Webhook-Ereignisnutzlast enthält auch Eigenschaften, die für das Ereignis eindeutig sind. Du kannst die eindeutigen Eigenschaften in den einzelnen Ereignistypabschnitten finden.

SchlüsseltypeBESCHREIBUNG
actionstringDie meisten Webhooknutzlasten enthalten eine Eigenschaft action, die die spezifische Aktivität enthält, die das Ereignis ausgelöst hat.
senderobjectDer Benutzer, der das Ereignis ausgelöst hat. Diese Eigenschaft ist in jeder Webhooknutzlast enthalten.
repositoryobjectDas repository, in dem das Ereignis aufgetreten ist. Webhooknutzlasten enthalten die Eigenschaft repository, wenn sich das Ereignis aus Aktivitäten in einem Repository ergibt.
organizationobjectWebhooknutzdaten enthalten das organization-Objekt, wenn der Webhook für eine Organisation konfiguriert ist oder das Ereignis über Aktivitäten in einem Repository auftritt, das einer Organisation gehört. installation

Die eindeutigen Eigenschaften für ein Webhookereignis sind die gleichen Eigenschaften, die du in der Eigenschaft payload findest, wenn du die Ereignis-API verwendest. Eine Ausnahme ist das push Ereignis. Die eindeutigen Eigenschaften der Nutzlast des Webhookereignisses push und die Eigenschaft payload in der Ereignis-API unterscheiden sich. Die Webhooknutzlast enthält ausführlichere Informationen.

Hinweis: Nutzlasten sind auf 25 MB begrenzt. Wenn dein Ereignis eine größere Nutzlast generiert, wird kein Webhook ausgelöst. 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:

HeaderBESCHREIBUNG
X-GitHub-EventName des Ereignisses, das die Übermittlung ausgelöst hat.
X-GitHub-DeliveryEine GUID, um die Übermittlung zu identifizieren.
X-Hub-SignatureDieser Header wird gesendet, wenn der Webhook mit einem secret konfiguriert ist. Dies ist der HMAC-Hex-Digest des Anforderungstexts und wird mithilfe der SHA-1-Hashfunktion und dem secret als HMAC key generiert. X-Hub-Signature wird für die Kompatibilität mit vorhandenen Integrationen bereitgestellt. Es wird empfohlen, stattdessen die sicherere X-Hub-Signature-256 zu verwenden.
X-Hub-Signature-256Dieser Header wird gesendet, wenn der Webhook mit einem secret konfiguriert ist. Dies ist der HMAC-Hex-Digest des Anforderungstexts und wird mithilfe der SHA-256-Hashfunktion und des secret als HMAC key generiert.

Außerdem weist User-Agent für die Anforderungen das Präfix GitHub-Hookshot/ auf.

Beispielübermittlung

> POST /payload HTTP/2

> Host: localhost:4567
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c
> User-Agent: GitHub-Hookshot/044aadd
> Content-Type: application/json
> Content-Length: 6615
> X-GitHub-Event: issues

> {
>   "action": "opened",
>   "issue": {
>     "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
>     "number": 1347,
>     ...
>   },
>   "repository" : {
>     "id": 1296269,
>     "full_name": "octocat/Hello-World",
>     "owner": {
>       "login": "octocat",
>       "id": 1,
>       ...
>     },
>     ...
>   },
>   "sender": {
>     "login": "octocat",
>     "id": 1,
>     ...
>   }
> }

branch_protection_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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

rule object Erforderlich

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

sender object Erforderlich

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string

Wert: completed

check_run object Erforderlich

A check performed on the code of a given code change

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

check_suite

This event occurs when there is activity relating to a check suite. For information about check suites, see "Getting started with the Checks API." For information about the APIs to manage check suites, 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 lease 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: completed

actions_meta object or null
check_suite object Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

code_scanning_alert

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "About code scanning" and "About code scanning alerts." For information about the API to manage code scanning, see "Code scanning" in the REST API documentation.

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

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: appeared_in_branch

alert object Erforderlich

The code scanning alert involved in the event.

commit_oid string Erforderlich

The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

ref string Erforderlich

The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

commit_comment

This event occurs when there is activity relating to commit comments. For more information about commit comments, see "Commenting on a pull request." For information about the APIs to manage commit comments, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

The action performed. Can be created.

Wert: created

comment object Erforderlich

The commit comment resource.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

create

This event occurs when a Git branch or tag is created.

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

Note: This event will not occur when more than three tags are created at once.

Verfügbarkeit für create

  • Repositorys
  • Organisationen
  • GitHub Apps

Webhooknutzlastobjekt für create

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
description string or null Erforderlich

The repository's current description.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

master_branch string Erforderlich

The name of the repository's default branch (usually main).

organization object

A GitHub organization.

pusher_type string Erforderlich

The pusher type for the event. Can be either user or a deploy key.

ref string Erforderlich

The git ref resource.

ref_type string Erforderlich

The type of Git ref object created in the repository.

Kann eine der Folgenden sein: tag, branch

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

delete

This event occurs when a Git branch or tag is deleted.

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

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pusher_type string Erforderlich

The pusher type for the event. Can be either user or a deploy key.

ref string Erforderlich

The git ref resource.

ref_type string Erforderlich

The type of Git ref object deleted in the repository.

Kann eine der Folgenden sein: tag, branch

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

dependabot_alert

This event occurs when there is activity relating to Dependabot alerts.

For more information about Dependabot alerts, see "About Dependabot alerts." For information about the API to manage Dependabot alerts, see "Dependabot alerts" in the REST API documentation.

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

Note: Webhook events for Dependabot alerts are currently in beta 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

alert object Erforderlich

A Dependabot alert.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

enterprise object

An enterprise on GitHub.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

deploy_key

This event occurs when there is activity relating to deploy keys. For more information, see "Managing deploy keys." For information about the APIs to manage deploy keys, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

key object Erforderlich

The deploy key resource.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

deployment

This event occurs when there is activity relating to deployments. For more information, see "About deployments." For information about the APIs to manage deployments, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

deployment object Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

workflow object or null Erforderlich
workflow_run object or null Erforderlich

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.

Verfügbarkeit für deployment_status

  • Repositorys
  • Organisationen
  • GitHub Apps

Webhooknutzlastobjekt für deployment_status

A new deployment status was created.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

check_run object or null
deployment object Erforderlich
deployment_status object Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

workflow object or null
workflow_run object or null

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.

Verfügbarkeit für discussion

  • Repositorys
  • Organisationen
  • GitHub Apps

Webhooknutzlastobjekt für discussion

A comment on the discussion was marked as the answer.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: answered

answer object Erforderlich
discussion object Erforderlich

A Discussion in a repository.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

discussion_comment

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, 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.

Verfügbarkeit für discussion_comment

  • Repositorys
  • Organisationen
  • GitHub Apps

Webhooknutzlastobjekt für discussion_comment

A comment on a discussion was created.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

comment object Erforderlich
discussion object Erforderlich

A Discussion in a repository.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

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

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
enterprise object

An enterprise on GitHub.

forkee Erforderlich

The created repository resource.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

github_app_authorization

This event occurs when a user revokes their authorization of a GitHub App. For more information, see "About apps." For information about the API to manage GitHub Apps, 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 user-to-server requests, which require GitHub App authorization, see "Identifying and authorizing users for GitHub Apps."

Verfügbarkeit für github_app_authorization

  • GitHub Apps

Webhooknutzlastobjekt für github_app_authorization

Someone revoked their authorization of a GitHub App.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: revoked

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

sender object Erforderlich

A GitHub user.

gollum

This event occurs when someone creates or updates a wiki page. For more information, see "About wikis."

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

Verfügbarkeit für gollum

  • Repositorys
  • Organisationen
  • GitHub Apps

Webhooknutzlastobjekt für gollum

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pages array of objects Erforderlich

The pages that were updated.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

installation

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

enterprise object

An enterprise on GitHub.

installation object Erforderlich

Installation

organization object

A GitHub organization.

repositories array of objects

An array of repository objects that the installation can access.

repository object

A repository on GitHub.

requester object or null
sender object Erforderlich

A GitHub user.

installation_repositories

This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

For more information about GitHub Apps, see "About apps." For information about the APIs to manage GitHub Apps, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: added

enterprise object

An enterprise on GitHub.

installation object Erforderlich

Installation

organization object

A GitHub organization.

repositories_added array of objects Erforderlich

An array of repository objects, which were added to the installation.

repositories_removed array of objects Erforderlich

An array of repository objects, which were removed from the installation.

repository object

A repository on GitHub.

repository_selection string Erforderlich

Describe whether all repositories have been selected or there's a selection involved

Kann eine der Folgenden sein: all, selected

requester object or null Erforderlich
sender object Erforderlich

A GitHub user.

installation_target

This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "About apps." For information about the APIs to manage GitHub Apps, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
account object Erforderlich
action string Erforderlich
changes object Erforderlich
enterprise object

An enterprise on GitHub.

installation object Erforderlich

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

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" or "Pull requests" repository permissions.

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

comment object Erforderlich

The comment itself.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

issue Erforderlich

The issue the comment belongs to.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

issues

This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

The action that was performed.

Wert: assigned

assignee object or null
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

issue object Erforderlich

The issue itself.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

label

This event occurs when there is activity relating to labels. For more information, see "Managing labels." For information about the APIs to manage labels, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

label object Erforderlich
organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object

A GitHub user.

marketplace_purchase

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "GitHub Marketplace." For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or "GitHub Marketplace" in the REST API documentation.

Verfügbarkeit für marketplace_purchase

  • GitHub Marketplace

Webhooknutzlastobjekt für marketplace_purchase

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

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: cancelled

effective_date string Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

marketplace_purchase Erforderlich
organization object

A GitHub organization.

previous_marketplace_purchase object
repository object

A repository on GitHub.

sender object Erforderlich

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: added

changes object
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

member object or null Erforderlich
organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

membership

This event occurs when there is activity relating to team membership. For more information, see "About teams." For more information about the APIs to manage team memberships, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: added

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

member object or null Erforderlich
organization object Erforderlich

A GitHub organization.

repository object

A repository on GitHub.

scope string Erforderlich

The scope of the membership. Currently, can only be team.

Wert: team

sender object or null Erforderlich
team object Erforderlich

Groups of organization members that gives permissions on specified repositories.

merge_group

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "Managing a merge queue."

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

Note: The pull request merge queue feature is currently in public beta and subject to change.

Verfügbarkeit für merge_group

  • GitHub Apps

Webhooknutzlastobjekt für merge_group

Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.

When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

merge_group object Erforderlich
organization object

A GitHub organization.

repository object

A repository on GitHub.

sender object

A GitHub user.

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: deleted

enterprise object

An enterprise on GitHub.

hook object Erforderlich

The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.

hook_id integer Erforderlich

The id of the modified webhook.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: closed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

milestone object Erforderlich

A collection of related issues and pull requests.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

org_block

This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "Blocking a user from your organization." For information about the APIs to manage blocked users, see the GraphQL documentation or "Blocking users" in the REST API documentation.

If you want to receive an event when members are added or removed from an organization, use the organization event instead.

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

Verfügbarkeit für org_block

  • Organisationen
  • Unternehmen
  • GitHub Apps

Webhooknutzlastobjekt für org_block

A user was blocked from the organization.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: blocked

blocked_user object or null Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object Erforderlich

A GitHub organization.

repository object

A repository on GitHub.

sender object Erforderlich

A GitHub user.

organization

This event occurs when there is activity relating to an organization and its members. For more information, see "About organizations." For information about the APIs to manage organizations, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: deleted

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

membership object

The membership between the user and the organization. Not present when the action is member_invited.

organization object Erforderlich

A GitHub organization.

repository object

A repository on GitHub.

sender object Erforderlich

A GitHub user.

package

This event occurs when there is activity relating to GitHub Packages. For more information, see "Introduction to GitHub Packages." For information about the APIs to manage GitHub Packages, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: published

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

package object Erforderlich

Information about the package.

repository object

A repository on GitHub.

sender object Erforderlich

A GitHub user.

page_build

This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "Configuring a publishing source for your GitHub Pages site." For information about the API to manage GitHub Pages, see "Pages" in the REST API documentation.

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

Verfügbarkeit für page_build

  • Repositorys
  • Organisationen
  • GitHub Apps

Webhooknutzlastobjekt für page_build

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
build object Erforderlich
enterprise object

An enterprise on GitHub.

id integer Erforderlich
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

personal_access_token_request

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "Creating a personal access token."

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

Note: Fine-grained PATs are in public beta. 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: approved

personal_access_token_request object Erforderlich

Details of a Personal Access Token Request.

organization object Erforderlich

A GitHub organization.

sender object Erforderlich

A GitHub user.

installation object Erforderlich

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

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

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
hook object

The webhook that is being pinged

hook_id integer

The ID of the webhook that triggered the ping.

organization object

A GitHub organization.

repository object

A repository on GitHub.

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 classic project. 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 or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), 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 classic project was converted to an issue.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: converted

changes object Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

project_card object Erforderlich
repository object

A repository on GitHub.

sender object Erforderlich

A GitHub user.

project

This event occurs when there is activity relating to a classic project. 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, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), 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 classic project was closed.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: closed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

project object Erforderlich
repository object

A repository on GitHub.

sender object Erforderlich

A GitHub user.

project_column

This event occurs when there is activity relating to a column on a classic project. 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 or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), 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 classic project.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

project_column object Erforderlich
repository object

A repository on GitHub.

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 beta 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: closed

organization object Erforderlich

A GitHub organization.

projects_v2 object Erforderlich

A projects v2 project

sender object Erforderlich

A GitHub user.

projects_v2_item

This event occurs when there is activity relating to an item on an organization-level project. For more information, see "About Projects." For information about the Projects API, 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.

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."

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: archived

changes object Erforderlich
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object Erforderlich

A GitHub organization.

projects_v2_item object Erforderlich

An item belonging to a project

sender object Erforderlich

A GitHub user.

public

This event occurs when repository visibility changes from private to public. For more information, see "Setting repository visibility."

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

Verfügbarkeit für public

  • Repositorys
  • Organisationen
  • GitHub Apps

Webhooknutzlastobjekt für public

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

pull_request

This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: assigned

assignee object or null Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

number integer Erforderlich

The pull request number.

organization object

A GitHub organization.

pull_request object Erforderlich
repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

pull_request_review_comment

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "Commenting on a pull request." For information about the APIs to manage pull request review comments, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

comment object Erforderlich

The comment itself.

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pull_request object Erforderlich
repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

pull_request_review

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "About pull request reviews." For information about the APIs to manage pull request reviews, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: dismissed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pull_request object Erforderlich
repository object Erforderlich

A repository on GitHub.

review object Erforderlich

The review that was affected.

sender object Erforderlich

A GitHub user.

pull_request_review_thread

This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "About pull request reviews." For information about the APIs to manage pull request review comment threads, 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 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: resolved

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pull_request object Erforderlich
repository object Erforderlich

A repository on GitHub.

sender object

A GitHub user.

thread object Erforderlich

push

This event occurs when a commit or tag is pushed.

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

Note: An event will not be created when more than three tags are pushed at once.

Verfügbarkeit für push

  • Repositorys
  • Organisationen
  • GitHub Apps

Webhooknutzlastobjekt für push

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
after string Erforderlich

The SHA of the most recent commit on ref after the push.

base_ref string or null Erforderlich
before string Erforderlich

The SHA of the most recent commit on ref before the push.

commits array of objects Erforderlich

An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.

compare string Erforderlich

URL that shows the changes in this ref update, from the before commit to the after commit. For a newly created ref that is directly based on the default branch, this is the comparison between the head of the default branch and the after commit. Otherwise, this shows all commits until the after commit.

created boolean Erforderlich

Whether this push created the ref.

deleted boolean Erforderlich

Whether this push deleted the ref.

enterprise object

An enterprise on GitHub.

forced boolean Erforderlich

Whether this push was a force push of the ref.

head_commit object or null Erforderlich
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

pusher object Erforderlich

Metaproperties for Git author/committer information.

ref string Erforderlich

The full git ref that was pushed. Example: refs/heads/main or refs/tags/v3.14.1.

repository object Erforderlich

A 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: published

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

registry_package object Erforderlich
repository object

A repository on GitHub.

sender object Erforderlich

A GitHub user.

release

This event occurs when there is activity relating to releases. For more information, see "About releases." For information about the APIs to manage releases, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

release object Erforderlich

The release object.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

repository

This event occurs when there is activity relating to repositories. For more information, see "About repositories." For information about the APIs to manage repositories, 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

  • Unternehmen
  • Repositorys
  • Organisationen
  • GitHub Apps

Webhooknutzlastobjekt für repository

A repository was archived.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: archived

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

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.

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

The event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich
branch string Erforderlich
client_payload object or null Erforderlich
enterprise object

An enterprise on GitHub.

installation object Erforderlich

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

repository_import

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

Verfügbarkeit für repository_import

  • Repositorys
  • Organisationen

Webhooknutzlastobjekt für repository_import

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

status string Erforderlich

Kann eine der Folgenden sein: success, cancelled, failure

repository_vulnerability_alert

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

Note: This event is deprecated. Use the dependabot_alert event instead.

Verfügbarkeit für repository_vulnerability_alert

  • Repositorys
  • Organisationen

Webhooknutzlastobjekt für repository_vulnerability_alert

A repository vulnerability alert was created.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: create

alert Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

secret_scanning_alert

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.

For activity relating to secret scanning alert locations, use 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

alert object Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string

Wert: created

alert object Erforderlich
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

location object Erforderlich
organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

security_advisory

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "About GitHub Security Advisories for repositories." For information about the API to manage security advisories, see 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: published

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

security_advisory object Erforderlich

The details of the security advisory, including summary, description, and severity.

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

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
changes object Erforderlich
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

Full Repository

sender object

A GitHub user.

sponsorship

This event occurs when there is activity relating to a sponsorship listing. For more information, see "About GitHub Sponsors." For information about the API to manage sponsors, 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: cancelled

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object

A repository on GitHub.

sender object Erforderlich

A GitHub user.

sponsorship object Erforderlich

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: created

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

starred_at string or null Erforderlich

The time the star was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Will be null for the deleted action.

status

This event occurs when the status of a Git commit changes. For example, commits can be marked 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 "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

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
avatar_url string or null
branches array of objects Erforderlich

An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches.

commit object Erforderlich
context string Erforderlich
created_at string Erforderlich
description string or null Erforderlich

The optional human-readable description added to the status.

enterprise object

An enterprise on GitHub.

id integer Erforderlich

The unique identifier of the status.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

name string Erforderlich
organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

sha string Erforderlich

The Commit SHA.

state string Erforderlich

The new state. Can be pending, success, failure, or error.

Kann eine der Folgenden sein: pending, success, failure, error

target_url string or null Erforderlich

The 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

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

team object Erforderlich

Groups of organization members that gives permissions on specified repositories.

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: added_to_repository

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object Erforderlich

A GitHub organization.

repository object

A git repository

sender object

A GitHub user.

team object Erforderlich

Groups of organization members that gives permissions on specified repositories.

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: started

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

workflow_dispatch

This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "Manually running a workflow."

For activity relating to workflow runs, use 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

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
enterprise object

An enterprise on GitHub.

inputs object or null Erforderlich
installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

ref string Erforderlich
repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A 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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: completed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

workflow_job Erforderlich
deployment object

A request for a specific ref(branch,sha,tag) to be deployed

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.

Header
Name, type, BESCHREIBUNG
Textparameter
Name, type, BESCHREIBUNG
action string Erforderlich

Wert: completed

enterprise object

An enterprise on GitHub.

installation object

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

organization object

A GitHub organization.

repository object Erforderlich

A repository on GitHub.

sender object Erforderlich

A GitHub user.

workflow object or null Erforderlich
workflow_run Erforderlich