Webhook in Advanced Klaviyo Data Platform begrijpen
Wat je leert
Leer meer over webhooks en hoe je ze kunt gebruiken om informatie naar applicaties van derden te sturen als reactie op gebeurtenissen verzamelen in Klaviyo. Ga voor meer gedetailleerde informatie over het ontvangen van systeemwebhooks naar onze bron voor ontwikkelaars over het werken met systeemwebhooks.
Advanced Klaviyo Data Platform is niet inbegrepen in Klaviyo's standaard marketingapplicatie en er is een abonnement nodig om toegang te krijgen tot de bijbehorende functionaliteit. Ga naar onze facturering gids om te leren hoe je dit abonnement kunt kopen.
Wat zijn webhooks?
Met webhooks kan Klaviyo informatie doorgeven of andere applicaties, tools en servers "aanroepen" via HTTP-verzoeken. Ze kunnen informatie sturen over een gebeurtenis die heeft plaatsgevonden (bijvoorbeeld een geplaatste bestelling, een nieuwe klant aanmelden, etc) of je externe systemen informeren dat de gebeurtenis heeft plaatsgevonden.
Klaviyo ondersteunt 2 soorten webhooks:
-
webhook in Advanced Klaviyo Data Platform
Webhook die beschikbaar zijn als onderdeel van het Advanced Klaviyo Data Platform worden gebruikt om uw externe systemen te informeren dat een bepaalde gebeurtenis heeft plaatsgevonden en stellen u in staat om informatie te verzenden als reactie op een breed scala aan gebeurtenissen zonder de beperkingen van een flow. -
Flow-webhooks
Flow-webhooks zijn alleen beschikbaar binnen de flows-interface en worden geactiveerd wanneer de Flow een bepaalde fase of stap bereikt. Ze kunnen worden gebruikt om gegevens te verzenden over de gebeurtenis of ontvanger die de Flow heeft geactiveerd.
Belangrijkste onderdelen van webhook
webhook bestaan uit een paar belangrijke onderdelen:
-
Onderwerp
De gebeurtenis die ervoor zorgt dat een webhook afgaat -
Body (of 'de payload')
De gegevens die de webhook verzendt -
Koppen
Een plaats om extra informatie door te geven (zoals verificatie)
Hoe verschillen webhook in Advanced Klaviyo Data Platform van flow webhook?
Je kunt webhook gebruiken in Advanced Klaviyo Data Platform of flow webhook, afhankelijk van je behoeften.
EvenementenEvenementen
flow webhook kan alleen reageren op een subset van Klaviyo gebeurtenissen en niet op support berichtgerelateerde gebeurtenissen zoals afmelden, Ontvangen e-mail of Klik op e-mail, omdat flow over het algemeen eindigt met berichtontvangst in plaats van ermee te beginnen. Ondertussen kun je met webhooks in het Advanced Klaviyo Data Platform informatie versturen als reactie op elke gebeurtenis in je account.
Deze omvatten:
- Email gebeurtenissen (bijv. Ontvangen e-mail, Geklikte e-mail, E-mail gemarkeerd als spam, afmelden)
- sms-gebeurtenissen (bijv. Verzonden sms, Ontvangen sms)
- pushmeldingsgebeurtenissen (bijv. Ontvangen push, Afgeslagen push)
- Gebeurtenissen van integraties (d.w.z. gebeurtenissen van integraties van de eerste partij die door Klaviyo zijn gemaakt)
- API-gebeurtenissen (bijvoorbeeld gebeurtenissen die zijn gesynchroniseerd via de API's van Klaviyo)
Lading
Met flow webhook kun je de gegevens in het verzoek aanpassen, maar je moet de payload handmatig samenstellen. Ondertussen gebruiken webhooks in het Advanced Klaviyo Data Platform een vooraf gebouwde payload die geen handmatig werk van jouw kant vereist, en worden ze gebruikt om externe systemen op de hoogte te stellen dat er een gebeurtenis heeft plaatsgevonden.
stroombeperkingenstroombeperkingen
Flow-webhooks moeten worden geconfigureerd binnen de flows-interface en u kunt niet meerdere triggers tegelijk gebruiken. Er moeten verschillende triggers worden gecreëerd via individuele flows, en deze zijn afhankelijk van de algemene status van de flow (een flow in concept zou bijvoorbeeld geen gegevens via de Flow-webhook verzenden). Ondertussen staan webhooks in Advanced KDP buiten de flows-interface en zijn ze niet afhankelijk van de reeks stappen die leiden tot de webhook-actie, zoals een Flow-webhook.
Webhook instellenWebhook instellen
Om een webhook in te stellen in Klaviyo, navigeer naar webhook onder Geavanceerd Klaviyo Data Platform > gegevensbeheer > webhook in Klaviyo.
Om een nieuwe webhook toe te voegen, klik je op de knop Maak webhook.
- Voer in het modaal Een webhook maken de informatie in. Dit omvat:
-
Naam
Hoe u uw webhook identificeert -
Eindpunt-URL
De URL die is gekoppeld aan de bestemming voor het webhook-verzoek. -
Geheime sleutel
Een unieke identificatiecode om Klaviyo-webhookverzoeken in uw andere systemen te identificeren. -
Beschrijving
Een optionele beschrijving voor je webhook.
-
Naam
- Kies in het gedeelte Onderwerpen de gebeurtenissen die u wilt gebruiken om de webhook-melding te activeren.
De callback URL moet:
- Een geldig URL-formaat zijn
- Begin met HTTPS://
- Geen zelfondertekend SSL-certificaat hebben
- Niet omleiden naar een andere URL
Zodra je hebt webhook gemaakt, wordt deze samen met de:
- Webhooknaam
- Webhook-URL
- Tijd van de laatste synchronisatie
- Status
Merk op dat het tot 15 minuten kan duren voordat de webhook begint met verzenden naar de URL.
Je kunt je webhook verwijderen of uitschakelen met het menu naast het item.
Test systeem webhookTest systeem webhook
Wanneer u een webhook instelt in Klaviyo, kunt u deze testen om te controleren of de verbinding succesvol is. Om uw webhook te testen, gebruikt u de knop Verbinding testen nadat u de vereiste velden hebt ingevuld.
Er verschijnt een menu waarin je een onderwerp kunt selecteren en een test naar je terugbel-URL kunt sturen.
Na het uitvoeren van de test zie je een bericht dat aangeeft of de test succesvol was, samen met de header en de body van het verzoek op het tabblad Response.
Om te controleren of een webhook melding afkomstig is van Klaviyo, gebruik je de geheime sleutel die je hebt gemaakt om het verzoek te identificeren.
Voorbeeld payload
Hieronder staat een voorbeeld van de payload voor een webhook-verzoek als reactie op het onderwerp Email delivered.
Merk op dat de payload anders kan zijn op basis van je account-specifieke gegevens.
{
" meta": {
"timestamp": "2023-08-10T07:25:23.700369+00:00",
"klaviyo_webhook_id": "ID",
"version": "2023-06-03"
},
" gegevens": [
{
" topic": "event: email_delivered",
" external_id": "ID",
" payload": {
" gegevens": {
"id" : "ID",
" type": "event",
" links": {
"self": "https://a.klaviyo.com/api/events/ID/"
},
" attributen: {
" uuid": "96150200-374e-11ee-8001-a163313bc6c2",
" datetime": "2023-08-10 07:21:56+00:00",
" timestamp": 1691652116 ,
" event_properties": {
" $ESP": 0,
" Onderwerp": "? Gratis (Cool!) Swag Alert ?",
" $message": "01H7F525FKR31P27Y7PNGVBBKK",
" $event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
" $group_ids": [
" V7adxq"
],
" $attribution": {
"$send_ts": 0,
"$attributed_event_id": ""
},
"Email Domein": "Klaviyo-demo.com",
"campagne Naam": "Dagelijkse nieuwsbrief: 2023-08-10",
" Inbox aanbieder": "Amazon SES Inbound",
" $_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
}
},
" relaties": {
" meetwaarde": {
" gegevens": {
"id": "ID",
"type": "metric"
},
" links": {
"self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
"related": "https://a.klaviyo.com/api/events/ID/metric/"
}
},
" profielgegevens": {
"id": "ID",
"type": "profile"
},
links": {
"self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
"related": "https://a.klaviyo.com/api/events/ID/profile/"
}
}
}
}
}
},
Extra hulpbronnen