Hinweis
Dieser Artikel gilt nur für das Veröffentlichen von Apps in GitHub Marketplace. Weitere Informationen zum Veröffentlichen GitHub Actions in GitHub Marketplace finden Sie unter Aktionen auf dem GitHub-Marktplatz veröffentlichen.
Der GitHub Marketplace-Ereigniswebhook kann nur über die GitHub Marketplace-Angebotsseite deiner Anwendung eingerichtet werden. Alle anderen Ereignisse kannst du auf der Seite „Entwicklereinstellungen“ deiner Anwendung konfigurieren. Wenn du noch keine GitHub Marketplace Auflistung erstellt hast, lies Entwerfen eines Eintrags für deine App, um zu erfahren, wie.
Erstellen eines Webhooks
Zum Erstellen eines Webhooks für dein GitHub Marketplace-Angebot, klicke auf der linken Seitenleiste deiner GitHub Marketplace-Angebotsseite auf Webhook. Es werden die folgenden Optionen für die Webhookkonfiguration angezeigt, die zum Konfigurieren deines Webhooks erforderlich sind:
URL der Nutzlast
Die Payload-URL ist die URL des Servers, der die Webhook-POST-Anforderungen empfängt.
Inhaltstyp
Webhooks können mithilfe unterschiedlicher Inhaltstypen übermittelt werden:
- Der Inhaltstyp
application/jsonbietet die JSON-Nutzdaten direkt als Text derPOST-Anforderung. - Der Inhaltstyp
application/x-www-form-urlencodedsendet die JSON-Nutzdaten als Formularparameter namenspayload.
Wähle die Einstellung aus, die deinen Anforderungen entspricht. GitHub empfiehlt die Verwendung des Inhaltstyps application/json.
Geheimnis
Wenn Sie ein Webhook-Geheimnis festlegen, können Sie sicherstellen, dass die an die Payload-URL gesendeten POST Anfragen von GitHub stammen. Wenn Sie ein Geheimnis festlegen, erhalten Sie die Header X-Hub-Signature und X-Hub-Signature-256 in der Webhook-POST-Anforderung. Weitere Informationen zur Verwendung eines Secrets mit einem Signatur-Header zum Schützen Ihrer Webhook-Nutzdaten finden Sie unter Validierung der Webhook-Lieferungen.
Aktiv
Standardmäßig sind Webhookübermittlungen „Aktiv“. Du kannst die Übermittlung von Webhook-Payloads während der Entwicklung deaktivieren, indem du „Aktiv“ abwählst. Wenn du Webhookübermittlungen deaktiviert hast, musst du „Aktiv“ auswählen, bevor du deine App zur Überprüfung übermittelst.
Anzeigen von Webhookübermittlungen
Nachdem du deinen GitHub Marketplace-Webhook konfiguriert hast, kannst du POST-Anforderungsnutzdaten auf der Seite Webhook des GitHub Marketplace-Angebots deiner Anwendung überprüfen. GitHub versendet fehlgeschlagene Übermittlungsversuche nicht erneut. Stellen Sie sicher, dass Ihre App alle Webhook-Nutzlasten empfangen kann, die von GitHub gesendet werden.
