Hinweis: GitHub-Webhooks unterstützen derzeit nicht IPv6, dies wird aber in Zukunft ergänzt. Der /meta-REST-API-Endpunkt gibt IPv6-Bereiche zurück, um diesen Übergang zu ermöglichen.
Mit Webhooks kannst du Integrationen erstellen oder einrichten, wie z. B. GitHub Apps oder OAuth Apps, die bestimmte Ereignisse auf GitHub.com abonnieren. Wenn ein solches Ereignis ausgelöst wird, senden wir HTTP POST-Nutzdaten an die für den Webhook konfigurierte URL. Webhooks können verwendet werden, um einen externen Issue-Tracker zu aktualisieren, CI-Builds auszulösen, eine Sicherungsspiegelung zu aktualisieren oder sogar eine Bereitstellung auf deinem Produktionsserver durchzuführen. Nur deine Fantasie setzt die Grenzen.
Webhooks können auf einer Organisation, einem bestimmten Repository oder einer GitHub App installiert werden. Nach der Installation wird der Webhook jedes Mal gesendet, wenn ein oder mehrere abonnierte Ereignisse auftreten.
Du kannst bis zu 20 Webhooks für jedes Ereignis auf jedem Installationsziel (bestimmte Organisation oder bestimmtes Repository) erstellen.
Ereignisse
Beim Konfigurieren eines Webhooks kannst du auswählen, welche Ereignisse dir Nutzlasten senden. Um die Anzahl von HTTP-Anforderungen an deinen Server zu begrenzen, solltest du nur die spezifischen Ereignisse abonnieren, die du behandeln möchtest. Standardmäßig wird für Webhooks, die in einer Organisation oder einem Repository installiert sind, nur das Pushereignis abonniert. Standardmäßig werden für Webhooks in GitHub Apps keine Ereignisse abonniert. Du kannst Ereignisse, die für einen Webhook abonniert sind, jederzeit ändern.
Jedes Ereignis entspricht einer bestimmten Gruppe von Aktionen, die bei deiner Organisation und bzw. oder dem Repository auftreten können. Wenn du beispielsweise das issues-Ereignis abonnierst, erhältst du jedes Mal detaillierte Nutzdaten, wenn ein Issue geöffnet, geschlossen, gekennzeichnet wird usw.
Eine vollständige Liste der verfügbaren Webhookereignisse und ihrer Nutzdaten findest du unter Webhook-Ereignisse und -Nutzlasten.
Ping-Ereignis
Wenn du einen neuen Webhook erstellst, senden wir dir ein einfaches ping-Ereignis, um dir mitzuteilen, dass du den Webhook richtig eingerichtet hast. Dieses Ereignis wird nicht gespeichert und ist daher nicht über den Ereignis-API-Endpunkt abrufbar.
Weitere Informationen zu ping-Ereigniswebhook-Nutzdaten findest du im ping-Ereignis.