Webhooks

Webhooks: Ihre Tools benachrichtigt, sobald ein Lauf endet.

Wenn die Anreicherung oder Generierung eines Stapels abgeschlossen wird, fehlschlägt oder gestoppt wird, sendet Upsellr ein signiertes Ereignis an die Adresse Ihrer Wahl. Ihr Tool übernimmt: Veröffentlichung, Prüfung, Export.

Kategorie
API
Richtung
Versand von Ereignissen
Format
JSON, signiert mit HMAC-SHA256
Endpunkte
Bis zu 25 pro Organisation
Wiederholungen
Bis zu 6 Versuche, über mehr als einen Tag
Einrichtung
Eine HTTPS-Adresse und ein Secret
Pläne
Plan Enterprise
Anbieter
Upsellr

01Was Webhooks leisten

Das Signal, das Ihre Tools voranbringt.

  1. 01

    Ein Ereignis am Ende jedes Laufs

    Abgeschlossen, fehlgeschlagen oder gestoppt: Am Ende jedes Anreicherungs- oder Generierungslaufs sendet Upsellr das Ereignis mit den Details des Laufs.

  2. 02

    Signiert und überprüfbar

    Jede Zustellung trägt eine ID, einen Zeitstempel und eine mit Ihrem Secret berechnete HMAC-SHA256-Signatur: Ihr Tool prüft, dass sie wirklich von Upsellr stammt.

  3. 03

    Wiederholt, bis sie ankommt

    Ohne 2xx-Antwort innerhalb von 10 Sekunden wiederholt Upsellr die Zustellung nach 1 Minute, 5 Minuten, 30 Minuten, 4 Stunden und dann 24 Stunden.

  4. 04

    Ein Protokoll jeder Zustellung

    Status, HTTP-Code, Anzahl der Versuche und Inhalt: Jede Zustellung lässt sich 7 Tage lang einsehen, und eine fehlgeschlagene wird mit einem Klick erneut gesendet.

  5. 05

    Verketten Sie Ihre Tools

    Veröffentlichen, ein Team benachrichtigen oder einen Export starten, sobald die Seiten bereit sind: Der Webhook gibt das Signal, Ihr Tool erledigt den Rest.

  6. 06

    Behalten Sie die Kontrolle

    Deaktivieren Sie einen Endpunkt, ändern Sie sein Secret oder löschen Sie ihn: Seine ausstehenden Wiederholungen werden abgebrochen.

02Erste Schritte

In wenigen Minuten verbunden.

  1. 01

    Öffnen Sie die Organisationseinstellungen

    Bereich API und Webhooks, Inhabern und Administratoren vorbehalten.

  2. 02

    Fügen Sie einen Endpunkt hinzu

    Eine HTTPS-URL, die aus dem Internet erreichbar ist.

  3. 03

    Kopieren Sie das Secret

    Es wird nur einmal angezeigt und dient zur Prüfung der Signatur jeder Zustellung.

  4. 04

    Prüfen Sie die Signatur

    Berechnen Sie die HMAC-SHA256-Signatur aus Zeitstempel und Inhalt neu, und lehnen Sie eine zu alte Zustellung ab.

  5. 05

    Antworten Sie schnell

    Eine 2xx-Antwort in weniger als 10 Sekunden, danach verarbeiten Sie den Rest auf Ihrer Seite.

03Ereignisse

Die gesendeten Ereignisse.

EreignisGesendetBei Bedarf wiederholt
Lauf abgeschlossen (workflow.run.completed)JaJa
Lauf fehlgeschlagen (workflow.run.failed)JaJa
Lauf gestoppt (workflow.run.stopped)JaJa

Kompatibilität und Voraussetzungen

  • Der Plan Enterprise
  • Eine öffentliche HTTPS-Adresse auf Port 443
  • Eine Inhaber- oder Administratorrolle
  • Eine 2xx-Antwort in weniger als 10 Sekunden
  • Tipp: Deduplizieren Sie anhand der Ereignis-ID

Sie behalten die Kontrolle

Zuverlässig von Grund auf.

  • Signiert mit HMAC-SHA256, mit einem eigenen Secret pro Endpunkt
  • Mindestens einmal zugestellt: Deduplizieren Sie anhand der Ereignis-ID
  • Bis zu 6 Mal wiederholt, über mehr als einen Tag
  • Per HTTPS gesendet, ausschließlich an öffentliche Adressen

04Fragen

Fragen zu Upsellr-Webhooks.

Sind Webhooks in meinem Plan enthalten?

Sie sind wie die API dem Plan Enterprise vorbehalten.

Welche Ereignisse werden gesendet?

Das Ende eines Anreicherungs- oder Generierungslaufs: abgeschlossen, fehlgeschlagen oder gestoppt. Jedes Ereignis enthält die Details des Laufs.

Wie prüfe ich, dass eine Zustellung von Upsellr stammt?

Berechnen Sie mit Ihrem Secret die HMAC-SHA256-Signatur aus Zeitstempel und Inhalt neu, vergleichen Sie sie mit dem Header X-Upsellr-Signature, und lehnen Sie Zustellungen ab, die älter als 5 Minuten sind.

Was passiert, wenn mein Server nicht antwortet?

Ohne 2xx-Antwort innerhalb von 10 Sekunden wiederholt Upsellr die Zustellung nach 1 Minute, 5 Minuten, 30 Minuten, 4 Stunden und dann 24 Stunden. Eine fehlgeschlagene Zustellung lässt sich auch manuell aus dem Protokoll erneut senden.

Kann ich dasselbe Ereignis zweimal erhalten?

Ja, das ist möglich: Die Zustellung ist mindestens einmal garantiert, ohne garantierte Reihenfolge. Deduplizieren Sie anhand der Ereignis-ID.

Wie lange wird das Protokoll aufbewahrt?

7 Tage, mit Status, HTTP-Code, Anzahl der Versuche und Inhalt jeder Zustellung.

Wie viele Endpunkte kann ich anlegen?

Bis zu 25 pro Organisation, jeder mit einem eigenen Secret, das Sie erneuern können.

Sendet ein Test im Workflow-Editor ein Ereignis?

Nein. Nur echte Läufe senden Ereignisse.

Ihr nächstes Produkt
verdient mehr als Copy-and-paste.

Geben Sie Ihrem KI-Team seine ersten Produkte.