Zum Inhalt springen
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhook-Abonnements für Advocate erstellen und verwalten

Webhooks sind Code, der ausgeführt wird, wenn ein Ereignis eintritt. Mit Advocate können Sie Webhooks verwenden, um eine URL zu registrieren, an die wir bei jedem Ereignis in Ihrem Programm eine POST-Anfrage senden, z. B. wenn für einen neuen Teilnehmer ein personalisierter Gutscheincode erstellt wird. Dabei wird ein Ereignisobjekt erstellt. Es gibt zwei Möglichkeiten, Webhooks zu erstellen und zu verwalten: über die Advocate API oder in der Advocate-Plattform. In diesem Hilfeartikel erfahren Sie, wie Sie Webhooks über die Advocate-Plattform verwalten.

Webhook-Abonnement erstellen

  1. Wählen Sie in der oberen Navigationsleiste [Benutzerprofil] → Einstellungen.

  2. Wählen Sie in der linken Spalte unter Advocate-Einstellungen, Webhooks.

  3. Wählen Sie auf der Seite Webhook-Abonnements , Abonnement erstellen.

  4. Geben Sie unter URL für POSTdie eindeutige Adresse ein, über die die Anwendung Echtzeitaktualisierungen zu bestimmten Ereignissen sendet.

  5. Optional können Sie unter Webhook-Nameden Namen des neuen Webhook-Abonnements eingeben.

  6. Wähle Speichern.

Webhook-Protokolle untersuchen

Wenn Sie eine URL registrieren, an die Advocate bei jedem Ereignis in Ihrem Programm eine POST-Anfrage sendet, können Sie die Protokolle einsehen und Fehler bei fehlgeschlagenen Webhook-Ereignissen untersuchen.

Webhook-Protokolle aufrufen

  1. Wählen Sie in der oberen Navigationsleiste [Benutzerprofil] → Einstellungen.

  2. Wählen Sie in der linken Spalte unter Advocate-Einstellungen, Webhooks.

  3. Wählen Sie auf der Seite Webhook-Abonnements , Protokolle anzeigen.

  4. Verwenden Sie die folgenden Filter unter Webhook-Ereignisprotokoll , um die Webhooks zu filtern.

    • Weitere Informationen finden Sie in der folgenden Filterreferenz .

Filterreferenz
Filter
Beschreibung

Typ

Nach dem Webhook- Ereignistypfiltern. Standardmäßig ist dieser Filter auf Alle Typen.

Zeitraum

Nach dem Zeitraum filtern, in dem der Webhook zuletzt aktualisiert wurde. Standardmäßig ist dieser Filter auf Gesamter Zeitraum.

Webhook-Details anzeigen

  1. Wählen Sie einen bestimmten Webhook aus, um die Ansicht Webhook-Details zu öffnen.

  2. Diese Ansicht enthält Informationen, mit denen Sie Fehler bei einem Webhook-Abonnement untersuchen können.

    • Weitere Informationen finden Sie in der folgenden Ereignisreferenz .

Ereignisreferenz
Filter
Beschreibung

Typ

Webhook-ID

Der eindeutige Bezeichner des Webhooks.

Erstellungsdatum

Das Datum, an dem der Webhook erstellt wurde.

Ereignisdaten

Die Nutzlast des Webhooks Nutzlast.

Abonnement(s)

Webhook-Abonnements, an die der Webhook gesendet wurde, und deren Status.

Abonnementdetails

Details zur Antwort, die vom Endpunkt des Webhook-Abonnements empfangen wurde. Dazu gehören beispielsweise Zustellversuche des Webhooks mit dem Zeitstempel des Versuchs, dem vom Ziel empfangenen HTTP-Statuscode und der Information, ob der Versuch wegen einer zu langen Wartezeit auf eine Antwort des Zielservers abgelaufen ist.

Webhook-Wiederholungssystem für fehlgeschlagene Ereigniszustellungen

  • Rest Hooks werden unmittelbar nach dem Auslösen eines Ereignisses zugestellt. Antwortet der Endpunkt nicht erfolgreich auf einen Zustellversuch (d. h. mit einem anderen Statuscode als 200), gilt die Zustellung als fehlgeschlagen.

  • Fehlgeschlagene Zustellungen werden jede Stunde nach dem vorherigen fehlgeschlagenen Versuch erneut versucht, bis entweder eine Zustellung erfolgreich ist oder 72 Versuche unternommen wurden (etwa 3 Tage bei einer Wiederholung pro Stunde).

  • Webhook-Endpunkte, die wiederholt Fehler zurückgeben, werden nach der folgenden Anzahl von Fehlern automatisch deaktiviert:

    Statuscode
    Empfangene Fehler

    4xx-Fehler

    1000

    5xx-Fehler

    2000

    3xx-Fehler

    2000

Zuletzt aktualisiert

War das hilfreich?