Webhooks in der Advanced Klaviyo Data Platform verstehen

Übersicht

Erfahre mehr über Webhooks und wie du sie nutzen kannst, um als Reaktion auf in Klaviyo erfasste Ereignisse Informationen an deine Drittanbieter-Apps zu senden. Wenn du detailliertere Informationen dazu möchtest, wie du System-Webhook empfängst, findest du in unserer Entwicklerressource unter Arbeiten mit System-Webhook mehr dazu.

This content requires Functional cookies to be enabled.

Update Cookie Settings

Was sind Webhooks?

Webhooks ermöglichen es Klaviyo, Informationen zu übergeben oder andere Anwendungen, Tools und Server per HTTP-Anfragen „aufzurufen“. Sie können Informationen zu einem Ereignis senden, das stattgefunden hat (z. B. eine aufgegebene Bestellung, ein*e neue*r Kund*in, der*die ein Abonnement abgeschlossen hat usw.), oder deine externen Systeme darüber informieren, dass das Ereignis stattgefunden hat.

Klaviyo unterstützt 2 Arten von Webhooks:

1. Webhooks in Advanced Klaviyo Data Platform
   Webhooks, die als Teil der Advanced Klaviyo Data Platform verfügbar sind, werden verwendet, um deine externen Systeme darüber zu informieren, dass ein bestimmtes Ereignis eingetreten ist, und ermöglichen es dir, als Reaktion auf eine Vielzahl von Ereignissen Informationen zu senden, ohne die Einschränkungen eines Flows.
2. Flow-Webhooks
   Flow-Webhooks sind nur in der Flow-Oberfläche verfügbar und werden ausgelöst, wenn der Flow eine bestimmte Phase oder einen bestimmten Schritt erreicht. Sie können verwendet werden, um Daten über das Ereignis oder die Empfänger*in zu senden, das bzw. die den Flow ausgelöst hat.

Hauptkomponenten von Webhooks

Webhooks bestehen aus einigen wichtigen Komponenten:

• Thema
  Das Ereignis, durch das ein Webhook ausgelöst wird
• Body (oder „die Payload“)
  Die Daten, die der Webhook sendet
• Header
  Ein Ort, um zusätzliche Informationen (z. B. Authentifizierung) zu übergeben

Wie unterscheiden sich Webhooks in der Advanced Klaviyo Data Platform von Flow-Webhooks?

Du kannst je nach Bedarf Webhooks in der Advanced Klaviyo Data Platform oder Flow-Webhooks verwenden.

Enthaltene Ereignisse

Flow-Webhook können nur auf einen Teil der Klaviyo-Events reagieren und unterstützen keine nachrichtenbezogenen Events wie abmelden, Received email oder Clicked email, da Flows in der Regel mit dem Empfang einer Nachricht enden, statt damit zu beginnen. Webhook in der Advanced Klaviyo Data Platform ermöglichen dir dagegen, Informationen als Reaktion auf jedes Event in deinem Konto zu senden.

Dazu gehören:

• E-Mail-Ereignisse (z. B. E-Mail empfangen, E-Mail angeklickt, E-Mail als Spam markiert, abmelden)
• SMS-Ereignisse (z. B. Gesendete SMS, Empfangene SMS)
• Ereignisse für Push-Benachrichtigungen (z. B. Push empfangen, Push zurückgewiesen)
• Ereignisse aus Integrationen (d. h. Ereignisse aus von Klaviyo erstellten First-Party-Integrationen)
• API-Ereignisse (z. B. Ereignisse, die über Klaviyo APIs synchronisiert wurden)

Payload

Flow-Webhooks ermöglichen es dir, die in der Anfrage enthaltenen Daten anzupassen, aber du musst den Payload manuell erstellen. Webhook(s) in Advanced Klaviyo Data Platform verwenden dagegen einen vorgefertigten Payload, der keine manuelle Arbeit deinerseits erfordert, und werden verwendet, um externe Systeme darüber zu benachrichtigen, dass ein Ereignis aufgetreten ist.

Flow-Einschränkungen

Flow-Webhooks müssen in der Flow-Oberfläche konfiguriert werden und erlauben es dir nicht, mehrere Trigger gleichzeitig zu verwenden. Unterschiedliche Trigger müssen über einzelne Flows erstellt werden und hängen vom Gesamtstatus des Flows ab (z. B. würde ein Flow im Entwurf keine Daten über den Flow-Webhook senden). Webhooks in der Advanced Klaviyo Data Platform hingegen existieren außerhalb der Flow-Oberfläche und sind nicht von der Abfolge der Schritte abhängig, die zur Webhook-Aktion führen, wie bei einem Flow-Webhook.

Webhook einrichten

Um einen Webhook in Klaviyo einzurichten, navigiere in Klaviyo zu Webhook unter Advanced Klaviyo Data Platform > Datenmanagement > Webhook.

Um einen neuen Webhook hinzuzufügen, klicke auf die Schaltfläche Webhook erstellen.

1. Gib im Modal Webhook erstellen die Informationen ein. Dazu gehören:
   • Name
     Anhand dessen du deinen Webhook identifizierst
   • Endpunkt-URL
     Die URL, die dem Ziel für die Webhook-Anfrage zugeordnet ist
   • Geheimer Schlüssel
     Ein eindeutiger Identifikator, um Klaviyo-Webhook-Anfragen in deinen anderen Systemen zu identifizieren
   • Beschreibung
     Eine optionale Beschreibung für deinen Webhook.
2. Wähle im Abschnitt Themen die Ereignisse aus, die die Webhook-Benachrichtigung auslösen sollen

Sobald du deinen Webhook erstellt hast, wird er zusammen mit den folgenden Angaben auf der Seite Webhooks aufgeführt:

• Name des Webhooks
• Webhook-URL
• Zeitpunkt der letzten Synchronisierung
• Status

Du kannst deinen Webhook über das Menü neben dem Element löschen oder deaktivieren.

System-Webhook testen

Wenn du einen Webhook in Klaviyo einrichtest, kannst du ihn testen, um sicherzustellen, dass die Verbindung erfolgreich ist. Um deinen Webhook zu testen, verwende die Schaltfläche Verbindung testen , nachdem du die erforderlichen Felder ausgefüllt hast.

Es wird ein Menü angezeigt, in dem du ein Thema auswählen und einen Test an deine Callback-URL senden kannst.

Nach dem Ausführen des Tests wird eine Nachricht angezeigt, die angibt, ob er erfolgreich war, zusammen mit dem Header und dem Body für die Anfrage, die im Tab Antwort ausgefüllt werden.

Beispiel-Payload

Unten findest du ein Beispiel für die Payload einer Webhook-Anfrage als Reaktion auf das Thema E-Mail zugestellt.

{
  "meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2023-06-03"
  },
  "data": [
    {
      "topic": "event: email_delivered",
      "external_id": "ID",
      "payload": {
        "data": {
          "id": "ID",
          "type": "event",
          "links": {
            "self": "https://a.klaviyo.com/api/events/ID/"
          },
          "attributes": {
            "uuid": "96150200-374e-11ee-8001-a163313bc6c2",
            "datetime": "2023-08-10 07:21:56+00:00",
            "timestamp": 1691652116,
            "event_properties": {
              "$ESP": 0,
              "Subject": "? Free (Cool!) Swag Alert ?",
              "$message": "01H7F525FKR31P27Y7PNGVBBKK",
              "$event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
              "$group_ids": [
                "V7adxq"
              ],
              "$attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
              "Email Domain": "klaviyo-demo.com",
              "Campaign Name": "Daily Newsletter: 2023-08-10",
              "Inbox Provider": "Amazon SES Inbound",
              "$_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
            }
          },
          "relationships": {
            "metric": {
              "data": {
                "id": "ID",
                "type": "metric"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
                "related": "https://a.klaviyo.com/api/events/ID/metric/"
              }
            },
            "profile": {
              "data": {
                "id": "ID",
                "type": "profile"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
                "related": "https://a.klaviyo.com/api/events/ID/profile/"
              }
            }
          }
        }
      }
    },
  

Weitere Ressourcen