Konfigurieren eines Webhooks zur Benachrichtigung über Planänderungen

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 kein GitHub Marketplace-Angebot erstellt hast, findest du Informationen dazu unter Entwerfen eines Angebots für deine App.

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/json bietet die JSON-Nutzdaten direkt als Text der POST-Anforderung.
• Der Inhaltstyp application/x-www-form-urlencoded sendet die JSON-Nutzdaten als Formularparameter namens payload.

Wähle die Einstellung aus, die deinen Anforderungen entspricht. GitHub empfiehlt die Verwendung des Inhaltstyps application/json.

Secret

Durch das Festlegen eines Webhookgeheimnisses kannst du sicherstellen, dass an die Nutzlast-URL gesendete POST-Anforderungen von GitHub Enterprise Cloud kommen. Wenn du einen geheimen Schlüssel festlegst, erhältst du die Header X-Hub-Signature und X-Hub-Signature-256 in der Webhook-POST-Anforderung. Weitere Informationen dazu, wie du ein Geheimnis mit einem Signaturheader verwendest, um deine Webhooknutzdaten zu schützen, findest du unter Sichern deiner Webhooks.

Aktiv

Standardmäßig sind Webhookübermittlungen „Aktiv“. Du kannst die Übermittlung von Webhooknutzlasten während der Entwicklung deaktivieren, indem du die Auswahl von „Aktiv“ aufhebst. 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. Bei fehlerhaften Übermittlungsversuchen führt GitHub keine erneute Übermittlung durch. Stelle daher sicher, dass deine App alle von GitHub gesendeten Webhook-Payloads empfangen kann.