Ein Webhook lässt eines Ihrer externen Systeme per HTTP-POST benachrichtigen, sobald einer Ihrer Process abgeschlossen ist, statt dass Sie die App oder Ihre E-Mails prüfen müssen.
Wo Sie einen Webhook konfigurieren
Öffnen Sie My Account → Web Hooks ("Define your web hooks here"). Derzeit gibt es ein einziges verfügbares Ereignis: Process End.
Einen Webhook einrichten
- Process End — die URL Ihres Endpunkts, Platzhalter "Your API URL". Sie muss mit https:// beginnen — eine einfache http://-Adresse wird abgelehnt.
- Your secret — Platzhalter "Your API secret". Fahren Sie über das Info-Symbol für den Hinweis, doch die tatsächliche Regel ist strenger, als es klingt: nur Kleinbuchstaben a–z und Ziffern 0–9, mindestens 32 Zeichen — keine Großbuchstaben, Leerzeichen oder Satzzeichen.
Klicken Sie unten auf der My-Account-Seite auf Save changes. Eine Bestätigung "The changes have been saved" erscheint.
Save changes validiert und speichert die gesamte My-Account-Seite auf einmal neu — hat irgendein anderes Feld auf der Seite einen Fehler, wird nichts auf der Seite gespeichert, auch Ihr Webhook nicht, und Sie erhalten keine Fehlermeldung, nur roten Text unter dem problematischen Feld. Durchsuchen Sie die Seite danach, bevor Sie annehmen, dass etwas anderes schiefgelaufen ist.
Einen Webhook entfernen oder ersetzen
Es gibt keinen Ein-/Aus-Schalter — leeren Sie das URL-Feld und klicken Sie auf Save changes, um ihn zu entfernen. Sie können nur eine URL pro Ereignis haben: Speichern Sie eine neue für Process End, ersetzt das die vorherige.
Wann er ausgelöst wird
Ein Process End-Webhook wird jedes Mal ausgelöst, wenn ein Lauf eines Ihrer Process Finished oder Failed erreicht — unabhängig von Ihrer E-Mail-Einstellung unter My Account → Notifications (siehe Einen Lauf in DQE One Standalone überwachen und verwalten). Verwendet wird der Webhook, der für denjenigen registriert ist, der die Konfiguration dieses Process zuletzt gespeichert hat — nicht zwingend die Person, die diesen konkreten Lauf gestartet hat.
Innerhalb einer DataPipeline (siehe Eine DataPipeline in DQE One Standalone konfigurieren) ist jeder Schritt selbst ein Process-Lauf, ein Webhook wird also einmal pro Schritt ausgelöst, der Finished oder Failed erreicht — für den Gesamtabschluss der DataPipeline selbst gibt es jedoch kein eigenes Ereignis.
Was gesendet wird
Eine POST-Anfrage mit einem JSON-Body:
{"event": "process_end", "proces_status": "Finished"}Dieses Feld heißt wirklich proces_status (nur ein "s") — kein Tippfehler in diesem Artikel, das wird tatsächlich so übertragen.
Die Header X-Hook-Signature und X-Hook-Timestamp erlauben Ihnen, die Anfrage zu überprüfen: Die Signatur ist ein HMAC-SHA256 aus Zeitstempel plus Rohdaten des Bodys, mit Ihrem Secret. Ihr Endpunkt muss innerhalb von 10 Sekunden mit einem Erfolgsstatus (2xx) antworten.
Es gibt keine automatische Wiederholung. Ist Ihr Endpunkt nicht erreichbar, läuft die Zeit ab oder antwortet er mit einem Fehler, ist diese Zustellung endgültig — beheben Sie Ihren Endpunkt, bevor der nächste Lauf eine weitere auslöst.
Zustellstatus prüfen
Es werden nur Fehlschläge angezeigt, als Meldung unter den Feldern des Webhooks auf My Account: "Webhook's last delivery failed. API status code: {code}. Error: {error}. Received on: {date} at {time}." (in Ihrer eigenen lokalen Zeit).
Eine erfolgreiche Zustellung zeigt überhaupt nichts an — keine Bestätigung, kein Protokoll. Sehen Sie keine Fehlermeldung, gehen Sie davon aus, dass es funktioniert. Es gibt auch keine Schaltfläche, um eine Testzustellung zu senden; die einzige Möglichkeit zu prüfen ist, einen echten Process laufen zu lassen.
Verknüpfung mit