Webhook in der erweiterten Klaviyo-Datenplattform verstehen
Du wirst lernen
Erfahre mehr über Webhook und wie du sie nutzen kannst, um Informationen als Reaktion auf Ereignisse, die in Klaviyo erfasst werden, an deine Drittanbieteranwendungen zu senden. Ausführlichere Informationen über den Empfang von System-Webhooks findest du in unserer Ressource für Entwickler über die Arbeit mit System-Webhooks.
Die erweiterte Klaviyo-Datenplattform ist nicht in der Standard-Marketinganwendung von Klaviyoenthalten und für den Zugriff auf die damit verbundenen Funktionen ist ein Abonnement erforderlich. In unserem Leitfaden zur Abrechnung erfährst du, wie du dieses Abonnement kaufen kannst.
Was sind Webhook?
Mit Webhook kann Klaviyo Informationen weitergeben oder andere Anwendungen, Tools und Server über HTTP-Anfragen "aufrufen". Sie können Informationen über ein Ereignis senden (z. B. eine Bestellung, einen neuen Kunden usw.) oder deine externen Systeme darüber informieren, dass das Ereignis eingetreten ist.
Klaviyo Unterstützt 2 Arten von Webhook:
-
Webhook in der Advanced Klaviyo Data Platform
Der Webhook, der als Teil der Advanced Klaviyo Data Platform verfügbar ist, wird verwendet, um deine externen Systeme zu benachrichtigen, dass ein bestimmtes Ereignis eingetreten ist, und ermöglicht es dir, Informationen als Reaktion auf eine breite Palette von Ereignissen zu senden, ohne die Einschränkungen einer Flow. -
Flow Webhook
Flow Webhooks sind nur in der Flow-Oberfläche verfügbar und werden ausgelöst, wenn die „ Flow “ eine bestimmte Phase oder einen bestimmten Schritt erreichen. Sie können verwendet werden, um Daten über das Ereignis oder den Empfänger, der die „ Flow“ ausgelöst hat, zu senden.
Die wichtigsten Komponenten von Webhook
Webhooks bestehen aus ein paar Schlüsselkomponenten:
-
Thema
Das Ereignis, das einen Webhook auslöst -
Body (oder „die Nutzlast“)
Die Daten, die der Webhook sendet -
Kopfzeilen
Ein Ort, um zusätzliche Informationen zu übermitteln (z. B. Authentifizierung)
Wie unterscheidet sich der Webhook in der Advanced Klaviyo Data Platform von Flow Webhook?
Je nach Bedarf kannst du Webhook in der Advanced Klaviyo Data Platform oder Flow Webhook verwenden.
Ereignisse inklusiveEreignisse inklusive
Flow Webhook kann nur auf eine Teilmenge von Klaviyo Ereignissen reagieren und unterstützt keine nachrichtenbezogenen Ereignisse wie Abmelden, Empfangene E-Mail oder Angeklickte E-Mail, da der Flow in der Regel mit dem Empfang der Nachricht endet und nicht mit ihr beginnt. Mit dem Webhook in der Advanced Klaviyo Data Platform kannst du Informationen als Reaktion auf jedes Ereignis in deinem Konto senden.
Dazu gehören:
- E-Mail-Ereignisse (z. B. Empfangene E-Mail, Angeklickte E-Mail, Als Spam markierte E-Mail, Abbestellt)
- SMS-Ereignisse (z. B. gesendete SMS, empfangene SMS)
- Push-Ereignisse (z. B. empfangener Push, abgeprallter Push)
- Ereignisse aus Integrationen (d.h. Ereignisse aus Erstanbieter-Integrationen, die von Klaviyo erstellt wurden)
- API Ereignisse (z. B. über die API vonKlaviyo synchronisierte Ereignisse)
Nutzlast
Flow Mit Webhook kannst du die Daten, die in der Anfrage enthalten sind, anpassen, aber du musst die Nutzlast manuell zusammenstellen. Der Webhook in der Advanced Klaviyo Data Platform hingegen verwendet eine vorgefertigte Nutzlast, die keine manuelle Arbeit auf deiner Seite erfordert, und wird verwendet, um externe Systeme zu benachrichtigen, dass ein Ereignis eingetreten ist.
Flow EinschränkungenFlow Einschränkungen
Flow Webhooks müssen in der Flow-Oberfläche eingerichtet werden und du kannst nicht mehrere Auslöser gleichzeitig verwenden. Verschiedene Auslöser müssen über einzelne Flows erstellt werden und hängen vom Gesamtstatus des „ Flow“ ab (z. B. würde ein Flow im Entwurfsstatus keine Daten über den Webhook „ Flow “ senden). In der Zwischenzeit gibt es Webhooks in der erweiterten Klaviyo-Datenplattform außerhalb der Flow-Oberfläche und sie hängen nicht von den Schritten ab, die zur Webhook-Aktion führen, wie zum Beispiel ein Webhook „ Flow “.
Webhook einrichtenWebhook einrichten
Um einen Webhook in Klaviyo einzurichten, navigiere zu Webhook unter Advanced Klaviyo Data Platform > Daten managment > Webhook in Klaviyo.
Um einen neuen Webhook hinzuzufügen, klicke auf die Schaltfläche Webhook erstellen.
- Gib im Modal " Einen Webhook erstellen " die Informationen ein. Dazu gehören:
-
Name
Wie du deinen Webhook identifizierst -
Endpunkt-URL
Die URL, die mit dem Ziel für die Webhook-Anfrage verbunden ist. -
Geheimer Schlüssel
Eine eindeutige Kennung, um Klaviyo-Webhook-Anfragen in deinen anderen Systemen zu erkennen. -
Beschreibung
Eine optionale Beschreibung für deinen Webhook.
-
Name
- Wähle im Abschnitt „Themen“ die Ereignisse aus, die die Webhook-Benachrichtigung auslösen sollen.
Die Callback-URL muss:
- Ein gültiges URL-Format sein
- Beginne mit HTTPS://
- Kein selbstsigniertes SSL-Zertifikat haben
- Nicht zu einer anderen URL umleiten
Sobald du deinen Webhook erstellt hast, wird er auf der Webhook-Seite zusammen mit dem:
- Webhook-Name
- Webhook URL
- Zeitpunkt der letzten Synchronisierung
- Status
Beachte, dass es bis zu 15 Minuten dauern kann, bis der Webhook mit dem Senden an die URL beginnt.
Du kannst deinen Webhook über das Menü neben dem Element löschen oder deaktivieren.
Testsystem WebhookTestsystem Webhook
Wenn du einen Webhook in Klaviyo einrichtest, kannst du ihn testen, um sicherzustellen, dass die Verbindung funktioniert. Um deinen Webhook zu testen, klick einfach auf „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 Rückruf-URL senden kannst.
Nachdem du den Test durchgeführt hast, siehst du eine Meldung, die angibt, ob der Test erfolgreich war, sowie die Kopfzeile und den Text der Anfrage auf der Registerkarte Antwort.
Um zu überprüfen, ob eine Webhook-Benachrichtigung von Klaviyo stammt, verwendest du den geheimen Schlüssel, den du erstellt hast, um die Anfrage zu identifizieren.
Beispiel Nutzlast
Nachfolgend findest du ein Beispiel für den Payload einer Webhook-Anfrage als Antwort auf das Thema " E-Mail zugestellt".
Beachte, dass die Nutzlast je nach deinen kontospezifischen Daten unterschiedlich sein kann.
{
" meta": {
"timestamp": "2023-08-10T07:25:23.700369+00:00",
"klaviyo_webhook_id": "ID",
"version": "2023-06-03"
},
" data": [
{
" topic": "event: E-Mail",
" 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,
" Betreff": "? Kostenloser (cooler!) Swag Alert ?",
" $message": "01H7F525FKR31P27Y7PNGVBBKK",
" $event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
" $group_ids": [
" V7adxq"
],
" $attribution": {
"$send_ts": 0,
"$attributed_event_id": ""
},
" E-Mail Domain": "Klaviyo-demo.com",
Kampagne Name": "Daily Newsletter: 2023-08-10", "Inbox Anbieter": "Amazon SES Inbound", "$_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK" } }, "relationships": { "Metrik": { "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/"
}
}, "Profil": { "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/"
}
}
}
}
}
},
Zusätzliche Ressourcen