Advocate-Webhook-Abonnements erstellen & 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, die wir per POST benachrichtigen, sobald ein Ereignis in Ihrem Programm eintritt, z. B. wenn ein benutzerdefinierter Gutscheincode für einen neuen Teilnehmer erstellt wird, ein Ereignisobjekt erstellt wird. Es gibt zwei Methoden zum Erstellen und Verwalten von Webhooks: über die Advocate-API oder in der Advocate-Plattform. Dieser Hilfsartikel erklärt, wie man Webhooks über die Advocate-Plattform verwaltet.

Erstellen Sie ein Webhook-Abonnement

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

2. In der linken Spalte unten Advocate-Einstellungen, wählen Sie Webhooks.

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

4. Unten An URL senden, geben Sie die eindeutige Adresse ein, die die Anwendung verwendet, um Echtzeit-Updates zu bestimmten Ereignissen zu senden.

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

6. Wählen Speichern.

Fehlerbehebung bei Webhook-Protokollen

Wenn Sie eine URL registrieren, an die Advocate bei jedem Ereignis in Ihrem Programm postet, können Sie die Protokolle überprüfen und alle fehlgeschlagenen Webhook-Ereignisse beheben.

Zugriff auf Ihre Webhook-Protokolle

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

2. In der linken Spalte unten Advocate-Einstellungen, wählen Sie Webhooks.

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

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

   • Beziehen Sie sich auf die Filterreferenz unten für weitere Informationen.

Filterreferenz

Filter	Beschreibung
Typ	Filtern Sie nach dem 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 Webhook-Details Ansicht zu öffnen.

2. Diese Ansicht liefert Informationen, die zur Fehlerbehebung eines Webhook-Abonnements verwendet werden können.

   • Beziehen Sie sich auf die Ereignisreferenz unten für weitere Informationen.

Ereignisreferenz

Filter	Beschreibung
Typ	Der Webhook Ereignistyp.
Webhook-ID	Der eindeutige Bezeichner 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. Details können den Zustellversuch des Webhooks enthalten, mit Angabe des Zeitstempels des Versuchs, des vom Ziel erhaltenen HTTP-Statuscodes und ob der Versuch aufgrund einer zu langen Wartezeit auf eine Antwort des Zielservers zeitlich begrenzt war.

Webhook-Wiederholungssystem für fehlgeschlagene Ereigniszustellungen

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

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

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

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