Webhooks am Ende eines Workflows empfangen
In Ihren Systemen benachrichtigt werden, wenn eine Workflow-Ausführung endet, fehlschlägt oder gestoppt wird, und die Signatur der Sendungen prüfen.
Webhooks benachrichtigen Ihre Systeme, wenn eine Workflow-Ausführung endet. Upsellr sendet dann eine Anfrage an die Adresse Ihrer Wahl. Sie sind im Tarif Enterprise enthalten.
Die Ereignisse
| Ereignis | Wann es ausgelöst wird |
|---|---|
| workflow.run.completed | Eine Ausführung endet erfolgreich |
| workflow.run.failed | Eine Ausführung schlägt fehl |
| workflow.run.stopped | Ein Nutzer stoppt eine Ausführung |
Jede Sendung enthält die vollständige Darstellung der Ausführung, im selben Format wie die öffentliche API. Die Registerkarte Ereigniskatalog beschreibt dieses Format.
Einen Endpunkt hinzufügen
- Öffnen Sie das Kontomenü, dann Verwalten und API & Webhooks.
- Klicken Sie in der Registerkarte Endpunkte auf Endpunkt hinzufügen.
- Geben Sie einen Name und die Endpunkt-URL ein. Nur öffentliche HTTPS-Adressen werden akzeptiert: Private Netzwerke und Weiterleitungen sind gesperrt.
- Aktivieren Sie die Zu empfangende Ereignisse und speichern Sie dann.
- Kopieren Sie das Signaturgeheimnis. Es wird nur einmal angezeigt.
Ein Endpunkt kann pausiert und wieder aktiviert werden. Wenn Sie das Geheimnis verlieren, klicken Sie auf Geheimnis erneuern und aktualisieren Sie Ihren Empfänger sofort.
Die Signatur prüfen
Jede Sendung trägt zwei Header: X-Upsellr-Timestamp, den Zeitstempel der Sendung, und X-Upsellr-Signature, in der Form v1= gefolgt von einem hexadezimalen Hash in Kleinbuchstaben. Der Hash ist ein HMAC-SHA256, berechnet mit dem Geheimnis des Endpunkts, über den Zeitstempel, einen Punkt und dann den unveränderten Body der Anfrage.
Prüfen Sie die Signatur am unveränderten Body, bevor Sie das JSON dekodieren. Vergleichen Sie die Signaturen in konstanter Zeit und lehnen Sie zu alte Zeitstempel ab.
Sendungen und Wiederholungsversuche
- Die Ereignisse werden als JSON per POST-Anfrage gesendet. Jede 2xx-Antwort bestätigt den Empfang.
- Bei einem Fehler versucht Upsellr es nach 1 Minute, 5 Minuten, 30 Minuten, 4 Stunden und 24 Stunden erneut.
- Ein Ereignis kann mehr als einmal ankommen, und die Reihenfolge ist nicht garantiert: Deduplizieren Sie anhand der Ereigniskennung.
Das Zustellungsprotokoll
Die Registerkarte Event-Zustellungen listet die Sendungen der letzten 7 Tage auf, mit ihrem Status, ihren Versuchen und ihrem Inhalt. Klicken Sie bei einer fehlgeschlagenen Sendung auf Fehlgeschlagene Zustellung wiederholen: Dasselbe Ereignis wird erneut gesendet, mit derselben Kennung.
Gut zu wissen
- Nur Eigentümer und Administratoren verwalten Endpunkte und wiederholen Sendungen.
- Das Löschen eines Endpunkts bricht seine ausstehenden Sendungen ab. Vorhandene Protokolle bleiben erhalten.