Skip to main content

Arten von Webhooks

Sie können Webhooks erstellen, um Ereignisse zu abonnieren, die in einem bestimmten Repository, einer Organisation, GitHub Marketplace bzw. GitHub Sponsors-Konto oder der GitHub App auftreten.

Informationen zu Webhook-Typen

Ein Webhook kann nur auf Ereignisse zugreifen, die im Repository, der Organisation, GitHub Marketplace- bzw. GitHub Sponsors-Konto oder der GitHub App, wo er installiert ist.

Sie können keine Webhooks für einzelne Benutzerkonten oder Ereignisse erstellen, die spezifisch für Benutzerressourcen sind, z. B. persönliche Benachrichtigungen oder Erwähnungen.

Zum Erstellen und Verwalten von Webhooks müssen Sie der Besitzer der Ressource sein oder über einen Administratorzugriff auf die Ressource verfügen, in der der Webhook erstellt wird und die auf Ereignisse überwacht wird. Um beispielsweise Webhooks in einer Organisation zu verwalten, benötigen Sie Administratorberechtigungen für diese Organisation.

Einige Webhook-Ereignisse sind für bestimmte Arten von Webhooks eindeutig. Beispielsweise kann ein Organisations-Webhook Ereignisse abonnieren, die nur auf Organisationsebene auftreten, die ein Repository-Webhook im Gegensatz dazu nicht abonnieren kann. Weitere Informationen über die spezifische Verfügbarkeit der einzelnen Webhooks finden Sie unter „Webhook-Ereignisse und -Nutzlasten“.

Weitere Informationen findest du unter Informationen zu Webhooks.

Repositorywebhooks

Sie können Webhooks in einem Repository erstellen, um Ereignisse zu abonnieren, die in diesem Repository auftreten. Sie müssen ein Repositorybesitzer sein oder Administratorzugriff im Repository haben, um Webhooks in einem Repository verwalten zu können. Sie können keine Webhooks in einem Repository erstellen, bearbeiten oder löschen, wenn Sie nicht über die erforderlichen Berechtigungen verfügen.

Sie können mehrere Webhooks in einem einzigen Repository erstellen. Sie können jedoch nur bis zu 20 Webhooks erstellen, die einzelne Ereignistypen abonnieren. In einem einzigen Repository könnten Sie zum Beispiel nur bis zu 20 verschiedene Webhooks erstellen, die jeweils das push-Ereignis abonnieren.

Sie können die Webschnittstelle GitHub oder die REST-API verwenden, um Repository-Webhook zu verwalten. Weitere Informationen findest du unter Erstellen von Webhooks, Bearbeiten von Webhooks und Deaktivieren von Webhooks. Weitere Informationen zur Verwendung der REST-API zur Verwaltung von Repository-Webhooks finden Sie unter „Repositorywebhooks“.

Organisationswebhooks

Sie können Webhooks in einer Organisation erstellen, um Ereignisse zu abonnieren, die in dieser Organisation auftreten. Organisations-Webhooks können Ereignisse abonnieren, die in allen Repositorys stattfinden, die sich im Besitz der Organisation befinden. Sie können auch Ereignisse abonnieren, die auf Organisationsebene außerhalb eines bestimmten Repositorys stattfinden, z. B. wenn ein neues Mitglied zur Organisation hinzugefügt wird.

Um in einer Organisation zu verwalten, müssen Sie Organisationsbesitzer sein.

Sie können mehrere Webhooks in einer einzigen Organisation erstellen. Sie können jedoch nur bis zu 20 Webhooks erstellen, die einzelne Ereignistypen abonnieren. In einer einzigen Organisation könnten Sie zum Beispiel nur bis zu 20 verschiedene Webhooks erstellen, die jeweils das push-Ereignis abonnieren.

Sie können die GitHub Webschnittstelle oder die REST API verwenden, um Organisations-Webhooks zu verwalten. Weitere Informationen findest du unter Erstellen von Webhooks, Bearbeiten von Webhooks und Deaktivieren von Webhooks. Weitere Informationen zur Verwendung der REST-API zum Verwalten von Organisations-Webhooks finden Sie unter „Organisationswebhooks“.

GitHub Marketplace-Webhooks

Sie können einen Webhook erstellen, um Ereignisse im Zusammenhang mit einer App zu abonnieren, die Sie auf GitHub Marketplace veröffentlicht haben. Sie können pro App in GitHub Marketplace nur einen Webhook erstellen. Nur der Besitzer der App oder ein App-Manager für die Organisation, die die App besitzt, kann einen GitHub Marketplace Webhook erstellen und verwalten.

Ein GitHub Marketplace-Webhook kann nicht gelöscht werden, aber Sie können ihn deaktivieren, um keine Webhook-Zustellungen mehr zu erhalten.

Sie können die GitHub-Webschnittstelle verwenden, um einen GitHub Marketplace-Webhook zu verwalten. Weitere Informationen findest du unter Erstellen von Webhooks, Bearbeiten von Webhooks und Deaktivieren von Webhooks.

GitHub Sponsors-Webhooks

Sie können Webhooks erstellen, um Ereignisse im Zusammenhang mit GitHub Sponsors zu abonnieren. Sie können nur bis zu 20 Webhooks für ein GitHub Sponsors-Konto erstellen.

Sie müssen Kontobesitzer sein oder über Administratorrechte für das geförderte Konto verfügen, um Förderungs-Webhooks zu verwalten.

Sie können die GitHub-Webschnittstelle verwenden, um GitHub Sponsors-Webhooks zu verwalten. Weitere Informationen findest du unter Erstellen von Webhooks, Bearbeiten von Webhooks und Deaktivieren von Webhooks.

GitHub App-Webhooks

Sie können eine GitHub App so konfigurieren, dass sie Webhooks empfängt, wenn bestimmte Ereignisse in einem Repository oder einer Organisation auftreten, auf die die App Zugriff gewährt hat.

Jede GitHub App verfügt über einen einzelnen Webhook, der automatisch von GitHub erstellt wird. Standardmäßig hat der Webhook keine Ereignisse abonniert. Sie können die Ereignisse konfigurieren, die der Webhook abonnieren soll. Ein GitHub App-Webhook kann nicht gelöscht werden, aber Sie können ihn deaktivieren, um keine Webhook-Zustellungen mehr zu erhalten.

Sie können die GitHub-Webschnittstelle oder die REST-API verwenden, um Webhook-Zustellungen für eine GitHub App zu verwalten. Weitere Informationen findest du unter Erstellen von Webhooks, Bearbeiten von Webhooks und Deaktivieren von Webhooks. Weitere Informationen zur Verwendung der REST-API zur Verwaltung von GitHub App-Webhooks finden Sie unter „GitHub-App-Webhooks“.