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-Anwendungen zu senden. Weitere Informationen dazu, wie du System-Webhooks empfängst, findest du in unserer Entwicklerressource unter Arbeiten mit System-Webhooks.

This content requires Functional cookies to be enabled.

Update Cookie Settings

Was sind Webhooks?

Webhooks ermöglichen es Klaviyo, Informationen weiterzugeben oder andere Anwendungen, Tools und Server über 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, die*der abonniert hat usw.), oder deine externen Systeme darüber benachrichtigen, dass das Ereignis eingetreten ist.

Klaviyo unterstützt 2 Arten von Webhooks:

1. Webhooks in Advanced Klaviyo Data Platform
   Webhooks, die im Rahmen von 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 durch die Einschränkungen eines Flows begrenzt zu sein.
2. Flow-Webhooks
   Flow-Webhooks sind Aktionen innerhalb von Flows. Sie senden Daten, wenn ein Profil die Webhook-Aktion erreicht, und können Informationen über dieses Profil oder das Ereignis enthalten, das 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 Advanced Klaviyo Data Platform von Flow-Webhooks?

Du kannst je nach deinen Anforderungen Webhooks in Advanced Klaviyo Data Platform oder Flow-Webhooks verwenden.

Enthaltene Ereignisse

In Metrik-ausgelösten Flows können Flow-Webhooks nur auf Ereignisse reagieren, die als Flow-Trigger unterstützt werden. Zum Beispiel sind Received Email und Clicked Email im Metrik-Trigger-Selektor nicht verfügbar, während abmelden von E-Mail-Marketing unterstützt wird. System-Webhooks in Advanced Klaviyo Data Platform ermöglichen es dir, Themen für nachrichtenbezogene Ereignisse sowie Ereignisse aus Integrationen und aus Klaviyos API auszuwählen.

Dazu gehören:

• E-Mail-Ereignisse (z. B. E-Mail erhalten, Auf E-Mail geklickt, E-Mail als Spam markiert, von E-Mail-Marketing 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 Erstanbieter-Integrationen, die von Klaviyo erstellt wurden)
• API-Ereignisse (z. B. Ereignisse, die über Klaviyo APIs synchronisiert wurden)

Payload

Flow-Webhooks ermöglichen es dir, die Anfragedaten anzupassen, indem du einen JSON-Body konfigurierst. System-Webhooks in der Advanced Klaviyo Data Platform verwenden eine vorgefertigte Payload mit Daten zu den Ereignissen, die aufgetreten sind. Eine einzelne Anfrage kann mehrere Ereignisse aus den von dir ausgewählten Themen enthalten.

Flow-Einschränkungen

Flow-Webhooks folgen dem Trigger und den Schritten des Flows, der sie enthält. Verwende separate Flows, um auf verschiedene Flow-Trigger zu reagieren. Die Webhook-Aktion muss Live sein, um Anfragen automatisch zu senden; eine Aktion im Status Entwurf sendet keine Anfragen. System-Webhooks werden außerhalb von Flows ausgeführt und können 1 Endpunkt mehrere Themen abonnieren lassen.

Webhook einrichten

1. Navigiere in Klaviyo zu Datenverwaltung > Webhook.
2. Klicke auf Webhook erstellen.
3. Gib auf der Seite Webhook erstellen die folgenden Informationen ein:
   • Name
     Anhand dessen du deinen Webhook identifizierst
   • Endpunkt-URL
     Die URL, die dem Ziel für die Webhook-Anfrage zugeordnet ist
   • Geheimer Schlüssel
     Gib einen geheimen Schlüssel mit 16–100 Zeichen ein. Klaviyo verwendet diesen Schlüssel, um Anfragen zu signieren, damit deine empfangende Anwendung überprüfen kann, dass sie von Klaviyo stammen.
   • Beschreibung
     Eine optionale Beschreibung für deinen Webhook.
4. Wähle unter Themen 1 oder mehrere Themen aus, die Benachrichtigungen auslösen sollen. Beispielsweise entspricht event:klaviyo.received_email „E-Mail erhalten“.

5. Optional: Teste die Verbindung vor dem Speichern mit den folgenden Schritten im Abschnitt System-Webhooks testen.
6. Klicke auf Speichern, um den Webhook zu erstellen. Klaviyo bringt dich zurück zur Seite Webhooks.

Nach dem Speichern wird dein Webhook auf der Seite Webhook mit den folgenden Details angezeigt:

• Name des Webhooks
• Endpunkt-URL (aus Sicherheitsgründen gekürzt)
• Status

Um keine Benachrichtigungen mehr zu senden, öffne das Menü neben dem Webhook und wähle Deaktivieren aus. Um sie zu entfernen, wähle Löschen aus und bestätige die Löschung.

System-Webhook testen

1. Nachdem du die erforderlichen Felder auf der Seite Webhook erstellen ausgefüllt und deine Themen ausgewählt hast, klicke auf Verbindung testen.

2. Wähle im Bereich Webhook testen unter Themen ein Thema aus, und klicke dann auf Testen, um eine Beispielanfrage an die URL deines Endpunkts zu senden.

3. Überprüfe die Nachricht, die angibt, ob der Test erfolgreich war. Der Tab Anfrage zeigt die Header und Payload, die an deinen Endpunkt gesendet wurden. Der Tab Antwort zeigt die Response-Header, den Body und den Statuscode des Endpunkts.

1. Klicke auf Abbrechen, um das Testfenster zu schließen und zu deiner Webhook-Konfiguration zurückzukehren.

Beispiel-Payload

Unten findest du eine Beispiel-Payload für eine Anfrage, die durch „Received Email“ (event:klaviyo.received_email) ausgelöst wird.

{
  "meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2024-06-28",
    "klaviyo_payload_id": "3843971dcfdee5083e6289e1bbdbb003e538b5a8a668fc43ae4f19d415ac18a2",
    "klaviyo_account_id": "ACCOUNT_ID"
  },
  "data": [
    {
      "topic": "event:klaviyo.received_email",
      "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