Erstellen von Webhooks

Sie können Webhooks erstellen, um bestimmte Ereignisse auf GitHub zu abonnieren.

In diesem Artikel

Über das Erstellen von Webhooks

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

Weitere Informationen zu den verschiedenen Webhooktypen findest du unter Arten von Webhooks.

Eine vollständige Liste der Webhookereignisse findest du unter Webhook-Ereignisse und Webhook-Nutzlasten.

Erstellen eines Repository-Webhooks

Sie können einen Webhook erstellen, um bestimmte Ereignisse in einem bestimmten Repository zu abonnieren. Sie müssen ein Repositorybesitzer sein oder Administratorzugriff im Repository haben, um Webhooks in diesem Repository zu erstellen.

Sie können die GitHub Webschnittstelle oder die REST-API verwenden, um einen Repository-Webhook zu erstellen. Weitere Informationen zur Verwendung der REST-API zum Erstellen eines Repositorywebhooks findest du unter REST-API-Endpunkte für Repository-Webhooks.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke in der linken Randleiste auf Webhooks.

  4. Klicke auf Add webhook (Webhook hinzufügen).

  5. Geben Sie unter „Nutzdaten-URL“ die URL ein, unter der Sie Nutzdaten erhalten möchten.

  6. Wähle optional das Dropdownmenü Inhaltstyp und dann ein Datenformat aus, um die Webhooknutzdaten zu empfangen.

    • application/json bietet die JSON-Nutzdaten direkt als Text der POST Anforderung.
    • application/x-www-form-urlencoded sendet die JSON-Nutzlast als Formularparameter namens payload.

  7. Geben Sie optional unter „Geheimnis“ eine Zeichenfolge ein, die als secret Schlüssel verwendet werden soll. Du solltest eine zufällige Textzeichenfolge mit hoher Entropie auswählen. Sie können den Geheimnis-Webhook nutzen, um eingehende Anforderungen nur auf von GitHub stammende Anforderungen zu beschränken. Weitere Informationen finden Sie unter Validierung der Webhook-Lieferungen.

  8. Wählen Sie unter "Welche Ereignisse sollen diesen Webhook auslösen?" die Webhook-Ereignisse aus, die Sie empfangen möchten. Sie sollten nur die Webhook-Ereignisse abonnieren, die Sie benötigen.

  9. Wenn Sie sich für Einzelne Ereignisse auswählen entschieden haben, wählen Sie die Ereignisse aus, die den Webhook auslösen sollen.

  10. Um den Webhook sofort nach dem Hinzufügen der Konfiguration zu aktivieren, wählst du Aktiv aus.

  11. Klicke auf Add webhook (Webhook hinzufügen).

Nachdem Sie einen neuen Webhook erstellt haben, sendet Ihnen GitHub ein einfaches ping Ereignis, damit Sie wissen, dass Sie den Webhook korrekt eingerichtet haben. Weitere Informationen finden Sie unter Webhook-Ereignisse und Webhook-Nutzlasten.

Erstellen eines Organisationswebhooks

Sie können einen Webhook erstellen, um Ereignisse zu abonnieren, die in einer bestimmten Organisation auftreten. Um Webhooks in dieser Organisation zu erstellen, müssen Sie Organisationsinhaber sein.

Sie können die GitHub Webschnittstelle oder die REST-API verwenden, um einen Organisationswebhook zu erstellen. Weitere Informationen zur Verwendung der REST-API zum Erstellen eines Organisationswebhooks findest du unter REST-API-Endpunkte für Organisationswebhooks.

  1. Klicken Sie in der oberen rechten Ecke einer beliebigen Seite auf Ihr Profilbild GitHub.
  2. Klicke Sie auf Ihre Organisationen.
  3. Klicke dann rechts neben der Organisation auf Einstellungen.
  4. Klicke in der linken Randleiste auf Webhooks.
  5. Klicke auf Add webhook (Webhook hinzufügen).
  6. Geben Sie unter „Nutzdaten-URL“ die URL ein, unter der Sie Nutzdaten erhalten möchten.
  7. Wähle optional das Dropdownmenü Inhaltstyp und dann ein Datenformat aus, um die Webhooknutzdaten zu empfangen.
    • application/json bietet die JSON-Nutzdaten direkt als Text der POST Anforderung.
    • application/x-www-form-urlencoded sendet die JSON-Nutzlast als Formularparameter namens payload.
  8. Geben Sie optional unter „Geheimnis“ eine Zeichenfolge ein, die als secret Schlüssel verwendet werden soll. Du solltest eine zufällige Textzeichenfolge mit hoher Entropie auswählen. Sie können den Geheimnis-Webhook nutzen, um eingehende Anforderungen nur auf von GitHub stammende Anforderungen zu beschränken. Weitere Informationen finden Sie unter Validierung der Webhook-Lieferungen.
  9. Wählen Sie unter „Welche Ereignisse sollen diesen Webhook auslösen?“ die Arten von Webhooks aus, die Sie empfangen möchten. Sie sollten nur die Webhook-Ereignisse abonnieren, die Sie benötigen.
  10. Wenn Sie sich für Einzelne Ereignisse auswählen entschieden haben, wählen Sie die Ereignisse aus, die den Webhook auslösen sollen.
  11. Um den Webhook sofort nach dem Hinzufügen der Konfiguration zu aktivieren, wählst du Aktiv aus.
  12. Klicke auf Add webhook (Webhook hinzufügen).

Nachdem Sie einen neuen Webhook erstellt haben, sendet GitHub Ihnen ein einfaches ping-Ereignis, damit Sie wissen, dass Sie den Webhook korrekt eingerichtet haben. Weitere Informationen finden Sie unter Webhook-Ereignisse und Webhook-Nutzlasten.

Erstellen eines GitHub Marketplace Webhooks

Sie können einen Webhook erstellen, um Ereignisse zu einer App zu abonnieren, die Sie in GitHub Marketplace veröffentlicht haben. Nur der Besitzer der App oder ein App-Manager für die App kann einen GitHub Marketplace Webhook erstellen.

  1. Navigieren Sie zu Ihrer GitHub Marketplace Eintragsseite.
  2. Klicken Sie neben dem GitHub Marketplace Eintrag, für den Sie Webhook-Lieferungen anzeigen möchten, auf "Eintrag verwalten".
  3. Klicken Sie auf der Randleiste auf Webhook.
  4. Geben Sie unter „Nutzdaten-URL“ die URL ein, unter der Sie Nutzdaten erhalten möchten.
  5. Wähle optional das Dropdownmenü Inhaltstyp und dann ein Datenformat aus, um die Webhooknutzdaten zu empfangen.
    • application/json bietet die JSON-Nutzdaten direkt als Text der POST Anforderung.
    • application/x-www-form-urlencoded sendet die JSON-Nutzlast als Formularparameter namens payload.
  6. Geben Sie optional unter „Geheimnis“ eine Zeichenfolge ein, die als secret Schlüssel verwendet werden soll. Du solltest eine zufällige Textzeichenfolge mit hoher Entropie auswählen. Sie können den Geheimnis-Webhook nutzen, um eingehende Anforderungen nur auf von GitHub stammende Anforderungen zu beschränken. Weitere Informationen finden Sie unter Validierung der Webhook-Lieferungen.
  7. Um den Webhook sofort nach dem Hinzufügen der Konfiguration zu aktivieren, wählst du Aktiv aus.
  8. Klicke auf Webhook erstellen.

Nachdem Sie einen neuen Webhook erstellt haben, sendet Ihnen GitHub ein einfaches ping-Ereignis, um Ihnen mitzuteilen, dass Sie den Webhook korrekt eingerichtet haben. Weitere Informationen finden Sie unter Webhook-Ereignisse und Webhook-Nutzlasten.

Erstellen eines GitHub Sponsors Webhooks

Sie können einen Webhook erstellen, um Ereignisse im Zusammenhang mit Ihren Sponsorings zu abonnieren. Nur der Besitzer des gesponserten Kontos kann Sponsoring-Webhooks für dieses Konto erstellen. Weitere Informationen findest du unter dem sponsorship-Ereignis des Webhooks, für das ein Sponsoring abonniert wurde.

  1. Klicke in der oberen rechten Ecke einer beliebigen Seite auf dein Profilbild und dann auf Your sponsors.
  2. Klicken Sie neben dem Konto, für das Sie einen Webhook erstellen möchten, auf Dashboard.
  3. Klicke auf der linken Randleiste auf Webhooks.
  4. Klicke auf Add webhook (Webhook hinzufügen).
  5. Geben Sie unter „Nutzdaten-URL“ die URL ein, unter der Sie Nutzdaten erhalten möchten.
  6. Wähle optional das Dropdownmenü Inhaltstyp und dann ein Datenformat aus, um die Webhooknutzdaten zu empfangen.
    • application/json bietet die JSON-Nutzdaten direkt als Text der POST Anforderung.
    • application/x-www-form-urlencoded sendet die JSON-Nutzlast als Formularparameter namens payload.
  7. Geben Sie optional unter „Geheimnis“ eine Zeichenfolge ein, die als secret Schlüssel verwendet werden soll. Du solltest eine zufällige Textzeichenfolge mit hoher Entropie auswählen. Sie können den Geheimnis-Webhook nutzen, um eingehende Anforderungen nur auf von GitHub stammende Anforderungen zu beschränken. Weitere Informationen finden Sie unter Validierung der Webhook-Lieferungen.
  8. Um den Webhook sofort nach dem Hinzufügen der Konfiguration zu aktivieren, wählst du Aktiv aus.
  9. Klicke auf Webhook erstellen.

Webhooks für ein GitHub App erstellen

Der Besitzer einer GitHub App App kann Webhook-Ereignisse abonnieren, um Benachrichtigungen zu empfangen, wenn bestimmte Ereignisse auftreten. Wenn der App-Besitzer App-Manager für GitHub App benannt hat, können App-Manager die App auch für Webhook-Ereignisse abonnieren. Weitere Informationen finden Sie unter Verwenden von Webhooks mit GitHub Apps.

Jeder GitHub App hat einen Webhook. Sie können den Webhook konfigurieren, wenn Sie eine GitHub AppRegistrierung durchführen, oder Sie können die Webhook-Konfiguration für eine vorhandene GitHub App Registrierung bearbeiten.

Weitere Informationen zum Konfigurieren eines Webhooks, wenn Sie ein GitHub App registrieren, finden Sie unter Registrieren einer GitHub-App.

So konfigurieren Sie einen Webhook für eine vorhandene GitHub App Registrierung:

  1. Klicke auf GitHub in der oberen rechten Ecke einer beliebigen Seite auf dein Profilfoto.

  2. Navigieren Sie zu den Einstellungen für Ihr Konto.

    • Klicken Sie bei einer App, die zu einem persönlichen Konto gehört, auf Einstellungen.
    • Für eine App im Besitz einer Organisation:
      1. Klicke Sie auf Ihre Organisationen.
      2. Klicken Sie rechts neben der Organisation auf Einstellungen.

  3. Klicke in der linken Randleiste auf Developer settings.

  4. Klicke auf der linken Randleiste auf GitHub Apps .

  5. Neben dem Webhook GitHub App, den Sie konfigurieren möchten, klicken Sie auf Bearbeiten.

  6. Wählen Sie unter „Webhook“ Aktiv aus.

  7. Geben Sie unter „Webhook-URL“ die URL ein, unter der Sie Nutzdaten erhalten möchten.

  8. Geben Sie optional unter „Webhook-Geheimnis“ eine Zeichenfolge ein, die als secret Schlüssel verwendet werden soll. Du solltest eine zufällige Textzeichenfolge mit hoher Entropie auswählen. Sie können das Webhook-Geheimnis verwenden, um eingehende Anfragen auf diejenigen zu beschränken, die von GitHub stammen. Weitere Informationen finden Sie unter Validierung der Webhook-Lieferungen.

  9. Klicken Sie auf Änderungen speichern.

  10. Klicken Sie in der Randleiste auf Berechtigungen und Ereignisse.

  11. Die spezifischen Webhookereignisse, die du für deine GitHub App-Registrierung auswählen kannst, werden durch den Typ der Berechtigungen bestimmt, die du für deine App ausgewählt hast. Du musst zuerst die Berechtigungen auswählen, über die deine App verfügen soll, und dann kannst du deine App für Webhookereignisse abonnieren, die sich auf diesen Berechtigungssatz beziehen.

    Wähle in den Abschnitten „Repositoryberechtigungen“, „Organisationsberechtigungen“ und „Kontoberechtigungen“ die Berechtigungen aus, die für die von deiner App abonnierten Ereignisse erforderlich sind. Weitere Informationen finden Sie unter Auswählen von Berechtigungen für eine GitHub App. Weitere Informationen zu überlegungen beim Ändern der Berechtigungen finden Sie unter Ändern einer GitHub App Registrierung.

  12. Wählen Sie unter „Ereignisse abonnieren“ die Webhook-Ereignisse aus, die Ihr GitHub App empfangen soll.

  13. Klicken Sie auf Änderungen speichern.

Sie können auch die REST-API verwenden, um einen Webhook für einen GitHub App zu erstellen. Weitere Informationen finden Sie unter REST-API-Endpunkte für GitHub App Webhooks.

Weiterführende Lektüre