Webhook-Abonnements für Advocate erstellen und verwalten

Webhooks sind Code, der ausgeführt wird, wenn ein Ereignis eintritt. Advocate ermöglicht es Ihnen, Webhooks zu verwenden, um eine URL zu registrieren, an die wir per POST senden, wenn in Ihrem Programm ein Ereignis eintritt, z. B. wenn ein Vanity-Coupon-Code für einen neuen Teilnehmer erstellt wird, wird ein Ereignisobjekt erstellt. Es gibt zwei Methoden zum Erstellen und Verwalten von Webhooks: über die Advocate API oder in der Advocate-Plattform. Dieser Hilfsartikel erklärt, wie Sie Webhooks über die Advocate-Plattform verwalten.

Ein Webhook-Abonnement erstellen

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

2. In der linken Spalte unten Advocate-Einstellungenwählen Sie Webhooks.

3. Auf der Webhook-Abonnements -Seite, wählen Sie Abonnement erstellen.

4. Unten An URL posten, geben Sie die eindeutige Adresse ein, die die Anwendung zum Senden von Echtzeit-Updates zu bestimmten Ereignissen verwendet.

5. Optional unten Webhook-Name, geben Sie den Namen des neuen Webhook-Abonnements ein.

6. Wählen Sie Speichern.

Webhook-Protokolle beheben

Wenn Sie eine URL registrieren, an die Advocate jedes Mal sendet, wenn in Ihrem Programm ein Ereignis eintritt, können Sie die Protokolle überprüfen und fehlgeschlagene Webhook-Ereignisse beheben.

Greifen Sie auf Ihre Webhook-Protokolle zu

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

2. In der linken Spalte unten Advocate-Einstellungenwählen Sie Webhooks.

3. Auf der Webhook-Abonnements -Seite, wählen Sie Protokolle anzeigen.

4. Verwenden Sie die untenstehenden Filter Webhooks-Ereignisprotokoll um die Webhooks zu filtern.

   • Lesen Sie die Filterreferenz unten für weitere Informationen.

Filterreferenz

Filter	Beschreibung
Typ	Filter für den Webhook Ereignistyp. Dieser Filter ist standardmäßig auf Alle Typen.
Zeitraum	Filtern Sie nach dem Zeitraum, in dem der Webhook zuletzt aktualisiert wurde. Dieser Filter ist standardmäßig auf Gesamte Zeit.

Webhook-Details anzeigen

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

2. Diese Ansicht bietet Informationen, die zur Fehlerbehebung bei einem Webhook-Abonnement verwendet werden können.

   • Lesen Sie die Ereignisreferenz unten für weitere Informationen.

Ereignisreferenz

Filter	Beschreibung
Typ	Der Webhook Ereignistyp.
Webhook-ID	Die eindeutige Kennung des Webhooks.
Erstellungsdatum	Das Datum, an dem der Webhook erstellt wurde.
Ereignisdaten	Der Webhook Nutzlast.
Abonnement(e)	Webhook-Abonnements, an die der Webhook gesendet wurde, und deren Status.
Abonnementdetails	Details zur Antwort, die vom Endpunkt des Webhook-Abonnements empfangen wurde. Die Details können den Zustellversuch des Webhooks umfassen, einschließlich des Zeitstempels des Versuchs, des vom Ziel empfangenen HTTP-Statuscodes und ob der Versuch aufgrund einer zu langen Wartezeit auf eine Antwort vom Zielserver ein Timeout hatte.

Webhook-Wiederholungsmechanismus für fehlgeschlagene Ereigniszustellungen

• Rest-Hooks werden unmittelbar nach Auslösen eines Ereignisses zugestellt. Wenn der Endpunkt auf einen Zustellversuch nicht erfolgreich antwortet (d. h. mit einem Statuscode ungleich 200 antwortet), wird die Zustellung als fehlgeschlagen betrachtet.

• Fehlgeschlagene Zustellungen werden nach dem vorherigen fehlgeschlagenen Versuch stündlich erneut versucht, bis entweder eine erfolgreiche Zustellung erfolgt oder bis 72 Versuche gemacht wurden (ungefähr 3 Tage bei einer Rate von 1 Wiederholungsversuch pro Stunde).

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

  Statuscode	Empfangene Fehler
  4xx-Fehler	1000
  5xx-Fehler	2000
  3xx-Fehler	2000