Ein Webhook ist eine HTTP-Anfrage, die ein Dienst an eine von Ihnen registrierte URL sendet, wann immer ein bestimmtes Ereignis eintritt. Er ermöglicht es Ihrem System, Daten in Echtzeit zu empfangen, anstatt eine API ständig abzufragen, um zu sehen, ob neue Informationen verfügbar sind. In einer Datenpipeline bedeutet das, dass ein Job auf ein Ereignis reagieren kann, sobald die Quelle es meldet.
Die Zahlungsplattform Stripe sendet beispielsweise Webhook-Ereignisse über HTTPS an Ihren Endpunkt als JSON-Nutzlast. Ihr Endpunkt muss POST-Anfragen akzeptieren und die empfangenen Ereignisdaten verarbeiten.
Wie die Webhook-Zustellung funktioniert
Die Dokumentation von Stripe zeigt die Hauptmechanismen:
- Registrierung: Sie registrieren eine Endpunkt-URL. Im Live-Modus erfordert Stripe eine öffentlich zugängliche HTTPS-URL.
- Schnelle Bestätigung: Der Endpunkt sollte schnell einen 2xx-Statuscode zurückgeben, bevor komplexe Logik, die zu einem Timeout führen könnte, verarbeitet wird.
- Wiederholungen: Wenn die Zustellung fehlschlägt, versucht Stripe bis zu drei Tage lang mit exponentiellem Backoff im Live-Modus.
- Reihenfolge: Stripe garantiert nicht, dass Ereignisse in der Reihenfolge ankommen, in der sie erstellt wurden.
Sicherung eines Webhook-Endpunkts
- Signaturen überprüfen: Stripe signiert jedes Ereignis mit einem HMAC unter Verwendung von SHA-256 und fügt die Signatur in den
Stripe-Signature-Header ein. - Wiederholungen blockieren: Die signierte Nutzlast enthält einen Zeitstempel, sodass Sie Ereignisse ablehnen können, die zu alt sind.
- Duplikate behandeln: Ein Endpunkt kann dasselbe Ereignis mehr als einmal empfangen. Protokollieren Sie die verarbeiteten Ereignis-IDs und überspringen Sie Wiederholungen.
- Sender auf die Erlaubenliste setzen: Stripe sendet Webhooks von einer veröffentlichten Liste von IP-Adressen, die Sie auf Ihre Firewall beschränken können.
Häufige Verwendungen von Webhooks
- Code und Bereitstellung: GitHub sendet eine HTTP POST-Nutzlast an Ihre URL für die Repository-Ereignisse, auf die Sie abonniert sind. In den Dokumenten werden Verwendungen wie das Starten von CI-Bauten, das Aktualisieren eines externen Fehlerverfolgers, das Auffrischen eines Backup-Spiegels und das Bereitstellen auf einem Produktionsserver aufgeführt.
- Zahlungen: Stripe-Webhooks ermöglichen es Ihnen, auf asynchrone Ereignisse zu reagieren, wie z. B. die Bestätigung einer Zahlung durch eine Bank, die Anfechtung einer Gebühr durch einen Kunden oder den Erfolg einer wiederkehrenden Zahlung.
- Nur das abonnieren, was Sie benötigen: Stripe rät davon ab, auf zusätzliche oder alle Ereignisse zu hören, da dies unnötige Belastungen für Ihren Server verursacht.