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

Eine Webhook-Abonnement erstellen

1. Wählen Sie in der oberen Navigationsleiste [Benutzerprofil] → Einstellungen.
2. In der linken Spalte unten Advocate-Einstellungen, wählen Sie Webhooks.
3. Auf dem 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 unten Webhook-Name, den Namen des neuen Webhook-Abonnements eingeben.
6. Wählen Sie Speichern.

Webhook-Protokolle beheben

Wenn Sie eine URL registrieren, an die Advocate immer dann Beiträge sendet, wenn in Ihrem Programm ein Ereignis eintritt, können Sie die Protokolle überprüfen und alle fehlgeschlagenen Webhook-Ereignisse beheben.

Auf Ihre Webhook-Protokolle zugreifen

1. Wählen Sie in der oberen Navigationsleiste [Benutzerprofil] → Einstellungen.
2. In der linken Spalte unten Advocate-Einstellungen, wählen Sie Webhooks.
3. Auf dem Webhook-Abonnements Seite wählen Sie Protokolle anzeigen.
4. Verwenden Sie die unten stehenden Filter Webhooks-Ereignisprotokoll um die Webhooks zu filtern.

   • Siehe die Filter-Referenz unten für weitere Informationen.

Filter-Referenz

Filter	Beschreibung
Typ	Nach dem Webhook Ereignistyp. Dieser Filter ist standardmäßig auf Alle Typen.
Zeitraum	Nach dem Zeitraum filtern, in dem der Webhook zuletzt aktualisiert wurde. Dieser Filter ist standardmäßig auf Gesamter Zeitraum.

Webhook-Details anzeigen

1. Wählen Sie einen bestimmten Webhook aus, um die Webhook-Details Ansicht zu öffnen.
2. Diese Ansicht bietet Informationen, die zur Fehlerbehebung bei einem Webhook-Abonnement verwendet werden können.

   • Siehe 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 Nutzdaten.
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 Zustellungsversuch des Webhooks enthalten, einschließlich des Zeitstempels des Versuchs, des vom Ziel empfangenen HTTP-Statuscodes und ob der Versuch wegen einer zu langen Antwortzeit des Zielservers ein Timeout hatte.

Webhook-Wiederholungssystem für fehlgeschlagene Ereigniszustellungen

• REST-Hooks werden sofort zugestellt, nachdem ein Ereignis ausgelöst wurde. Wenn der Endpunkt auf einen Zustellungsversuch nicht erfolgreich antwortet (d. h. mit einem anderen Statuscode als 200 antwortet), gilt die Zustellung als fehlgeschlagen.
• Fehlgeschlagene Zustellungen werden nach dem vorherigen fehlgeschlagenen Versuch stündlich erneut versucht, bis entweder eine erfolgreiche Zustellung erfolgt oder 72 Versuche unternommen wurden (ungefähr 3 Tage bei einer Rate von 1 Wiederholungsversuch pro Stunde).
• Webhook-Endpunkte, die fortlaufend Fehler zurückgeben, werden nach der folgenden Anzahl von Fehlern automatisch deaktiviert:

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