Webhooks in Advanced Klaviyo Data Platform begrijpen

Wat je leert

Lees meer over webhooks en hoe je ze kunt gebruiken om informatie naar je applicaties van derden te sturen als reactie op gebeurtenissen die in Klaviyo worden vastgelegd. Ga voor meer gedetailleerde informatie over hoe je systeemwebhooks kunt ontvangen naar onze bron voor ontwikkelaars over werken met systeemwebhooks.

This content requires Functional cookies to be enabled.

Update Cookie Settings

Wat zijn webhooks?

Webhooks stellen Klaviyo in staat om informatie door te geven of andere applicaties, tools en servers te "roepen" via HTTP-verzoeken. Ze kunnen informatie versturen over een gebeurtenis die heeft plaatsgevonden (bijv. een geplaatste bestelling, een nieuwe klant die zich heeft aangemeld, enz.) of je externe systemen laten weten dat de gebeurtenis heeft plaatsgevonden.

Klaviyo ondersteunt 2 soorten webhooks:

1. Webhook in Advanced Klaviyo Data Platform
   Webhook die beschikbaar zijn als onderdeel van Advanced Klaviyo Data Platform worden gebruikt om je externe systemen te laten weten dat er een bepaalde gebeurtenis heeft plaatsgevonden, en stellen je in staat om informatie te verzenden als reactie op een breed scala aan gebeurtenissen, zonder de beperkingen van het werken in een flow.
2. Flowwebhooks
   Flowwebhooks zijn alleen beschikbaar binnen de flowinterface 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.

Belangrijke onderdelen van webhooks

Webhooks bestaan uit een paar belangrijke onderdelen:

• Onderwerp
  De gebeurtenis waardoor een webhook wordt geactiveerd
• Body (of ‘de payload’)
  De gegevens die de webhook verzendt
• Kopteksten
  Een plek om aanvullende informatie door te geven (zoals verificatie)

Hoe verschillen webhook(s) in Advanced Klaviyo Data Platform van flow-webhook(s)?

Je kunt webhooks gebruiken in Advanced Klaviyo Data Platform of flow-webhooks, afhankelijk van wat je nodig hebt.

Inbegrepen events

Flow-webhooks kunnen alleen reageren op een subset van Klaviyo-events en ondersteunen geen berichtgerelateerde events zoals afmelden, E-mail ontvangen of E-mail aangeklikt, omdat flows meestal eindigen met het ontvangen van een bericht in plaats van ermee te beginnen. Ondertussen kun je met webhooks in het Advanced Klaviyo Data Platform informatie verzenden als reactie op elk event in je account.

Deze omvatten:

• E-mailgebeurtenissen (bijv. E-mail ontvangen, E-mail aangeklikt, E-mail als spam gemarkeerd, Afmelden)
• sms-gebeurtenissen (bijv. Sms verzonden, Sms ontvangen)
• Pushmeldingsgebeurtenissen (bijv. Push ontvangen, Push gebounced)
• Events uit integraties (d.w.z. events uit first-party-integraties die door Klaviyo zijn gemaakt)
• API-events (bijv. events die zijn gesynchroniseerd via Klaviyo’s API)

Payload

Met flow webhooks kun je de gegevens aanpassen die in het verzoek worden opgenomen, maar je moet de payload handmatig opstellen. Ondertussen gebruiken webhooks in Advanced Klaviyo Data Platform een vooraf samengestelde payload waarvoor je geen handmatig werk hoeft te doen, en worden ze gebruikt om externe systemen te laten weten dat er een gebeurtenis heeft plaatsgevonden.

Beperkingen van de flow

Flow-webhooks moeten worden geconfigureerd in de flow-interface en je kunt niet meerdere triggers tegelijk gebruiken. Verschillende triggers moeten worden gemaakt via afzonderlijke flows en zijn afhankelijk van de algehele status van de flow (bijv. een flow in concept zou geen gegevens verzenden via de flow-webhook). Ondertussen bestaan webhooks in Advanced Klaviyo Data Platform buiten de flow-interface en zijn ze niet afhankelijk van de reeks stappen die voorafgaat aan de webhookactie, zoals bij een flow-webhook.

Webhooks instellen

Om een webhook in Klaviyo in te stellen, ga je naar Webhooks onder Advanced Klaviyo Data Platform > Data managment > Webhooks in Klaviyo.

Om een nieuwe webhook toe te voegen, klik je op de knop Webhook maken.

1. Voer in het modaal venster Een webhook maken de informatie in. Dit omvat:
   • Naam
     Hoe je je webhook herkent
   • Eindpunt-URL
     De URL die is gekoppeld aan de bestemming voor de webhook-aanvraag
   • Geheime sleutel
     Een unieke identificatiecode om Klaviyo-webhookverzoeken in je andere systemen te identificeren
   • Beschrijving
     Een optionele beschrijving voor je webhook.
2. Kies in de sectie Onderwerpen de gebeurtenissen die je de webhookmelding wilt laten activeren

Zodra je je webhook hebt gemaakt, wordt deze samen met het volgende vermeld op de pagina webhook:

• Webhooknaam
• Webhook-URL
• Tijdstip van de meest recente synchronisatie
• Status

Je kunt je webhook verwijderen of uitschakelen via het menu naast het item.

Systeemwebhooks testen

Wanneer je een webhook instelt in Klaviyo, kun je deze testen om er zeker van te zijn dat de verbinding succesvol is. Om je webhook te testen, gebruik je de knop Verbinding testen nadat je de vereiste velden hebt ingevuld.

Er verschijnt een menu waarin je een onderwerp kunt selecteren en een test naar je callback-URL kunt verzenden.

Na het uitvoeren van de test zie je een bericht dat aangeeft of het succesvol was, samen met de header en body voor de aanvraag die zijn ingevuld op het tabblad Antwoord.

Voorbeeld van payload

Hieronder vind je een voorbeeld van de payload voor een webhook-aanvraag als reactie op het onderwerp Email delivered.

{
  "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/"
              }
            }
          }
        }
      }
    },
  

Extra hulpbronnen