Förstå webhook i avancerad Klaviyo Data Platform

Du kommer att lära dig

Lär dig mer om webhook och hur du kan använda dem för att skicka information till dina tredjepartsapplikationer som svar på händelser samla in Klaviyo. För mer detaljerad information om hur du tar emot system webhook, gå till vår utvecklarresurs om att arbeta med system webhook.

Vad är webhook?

webhook gör det möjligt för Klaviyo att skicka information eller "ringa" andra applikationer, verktyg och servrar via HTTP-förfrågningar. De kan skicka information om en händelse som har inträffat (t.ex. en beställning, en ny kund prenumerera, etc) eller meddela dina externa system att händelsen har inträffat.

Klaviyo stödja 2 typer av webhook:

1. webhook i Avancerad Klaviyo Dataplattform
   webhook som finns som en del av Advanced Klaviyo Data Platform används för att meddela dina externa system att en viss händelse har inträffat och låter dig skicka information som svar på ett brett utbud av händelser utan begränsningarna av att vara i ett flöde.
2. Flödeswebhooks
   Flow-webhooks är endast tillgängliga i flödesgränssnittet och aktiveras när flödet når ett visst stadium eller steg. De kan användas för att skicka data om händelsen eller mottagaren som utlöste flödet.

Nyckelkomponenter i webhook

webhook består av några viktiga komponenter:

• Ämne
  Händelsen som gör att en webhook utlöses
• Kropp (eller ”nyttolasten”)
  De data som webhooken skickar
• Rubriker
  En plats för att skicka ytterligare information (t.ex. autentisering)

Hur skiljer sig webhook i Advanced Klaviyo Data Platform från flöde webhook?

Du kan använda webhook i Advanced Klaviyo Data Platform eller flöde webhook beroende på dina behov.

Evenemang inkluderade

flöde webhook kan bara svara på en delmängd av Klaviyo händelser, och inte support meddelanderelaterade händelser som avsluta prenumeration, Mottagen e-post eller Klickad e-post eftersom flöde i allmänhet slutar med mottagande av meddelande snarare än att börja med dem. Med hjälp av webhook i Advanced Klaviyo Data Platform kan du skicka information som svar på alla händelser i din Konto.

Dessa inkluderar:

• e-posthändelser (t.ex. Mottagen e-post, Klickad e-post , Markerad e-post som skräppost, Avsluta prenumeration)
• sms-händelser (t.ex. skickade sms, mottagna sms)
• pushnotis-händelser (t.ex. Mottagen pushnotis, Studsad pushnotis)
• Händelser från integrerare (dvs. händelser från förstapartsintegrerare som skapats av Klaviyo)
• API-händelser (t.ex. händelser som synkroniseras via Klaviyos API:er)

Nyttolast

flöde webhook kan du anpassa data som ingår i begäran, men du måste manuellt konstruera nyttolasten. Samtidigt använder webhook i Advanced Klaviyo Data Platform en förbyggd nyttolast som inte kräver något manuellt arbete från din sida, och används för att meddela externa system att en händelse har inträffat.

flödesbegränsningar

Flödeswebhooks måste konfigureras i flödesgränssnittet och tillåter inte att flera utlösare används samtidigt. Olika utlösare måste skapas genom individuella flöden och är beroende av flödets övergripande status (t.ex. skulle ett flöde i utkast inte skicka data via flödets webbhook). Webhooks i Advanced KDP finns utanför flödesgränssnittet och är inte beroende av den serie steg som leder fram till webhook-åtgärden, som en Flow-webhook.

Konfigurera webhook

För att ställa in en webhook i Klaviyo, navigera till webhook under Advanced Klaviyo Data Platform > datahantering > webhook i Klaviyo.

Om du vill lägga till en ny webhook klickar du på knappen Create webhook.

1. Ange informationen i modalrutan Create a webhook (Skapa en webhook ). Detta ingår:
   • Namn
     Hur du identifierar din webhook
   • Slutpunkts-URL
     Den URL som är associerad med destinationen för webhook-begäran.
   • Hemlig nyckel
     En unik identifierare för att identifiera Klaviyo-webhook-förfrågningar i dina andra system.
   • Beskrivning
     En valfri beskrivning av din webhook.
2. I avsnittet Ämnen väljer du de händelser som du vill ska utlösa webbhook-aviseringar.

När du har skapat din webhook kommer den att listas på webhook-sidan tillsammans med:

• Namn på webhook
• URL för webhook
• Tidpunkt för den senaste synkroniseringen
• Status

Du kan ta bort eller inaktivera din webhook med hjälp av menyn bredvid objektet.

Webhook för testsystem 

När du konfigurerar en webhook i Klaviyo kan du testa den för att säkerställa att anslutningen fungerar. För att testa din webhook, använd knappen Testa anslutning efter att du har fyllt i de obligatoriska fälten.

En meny visas där du kan välja ett ämne och skicka ett test till din återuppringningsadress. 

När du har utfört testet visas ett meddelande som anger om det lyckades, tillsammans med rubriken och texten för begäran som fylls i på fliken Response.

Exempel på nyttolast

Nedan visas ett exempel på nyttolasten för en webhook -begäran som svar på e-postmeddelandet. 

{
 " 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/"
          },
 " attribut": {
            "uuid": "96150200-374e-11ee-8001-a163313bc6c2",
 " datetime": "2023-08-10 07:21:56+00:00",
 " timestamp": 1691652116,
 " event_properties": {
 " $ESP": 0,
 " Subject": "? Gratis (cool!) Swag Alert ?",
 " $meddelande": "01H7F525FKR31P27Y7PNGVBBKK",
 " $event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
 " $group_ids": [
 " V7adxq"
 ],
 " $attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
 " e-post Domain": "Klaviyo-demo.com",
              "kampanj Namn": "Dagligt nyhetsbrev: 2023-08-10",
 " Inbox leverantör": "Amazon SES Inbound",
 " $_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
 }
         },
 " relationer": {
 " mättal": {
 "data" : {
                "id": "ID",
                "type": "metric"
              },
 " länkar": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
                "related": "https://a.klaviyo.com/api/events/ID/metric/"
              }
            },
 " profildata" : {
                "id": "ID",
                "type": "profile"
              }, " länkar": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
                "related": "https://a.klaviyo.com/api/events/ID/profile/"
              }
            }
          }
        }
      }
    },
  

Ytterligare resurser

Så här lägger du till en webhook-åtgärd i ett flöde

Förståelse av Klaviyo webhook

Arbeta med systemets webhook (Klaviyo:s webhook API)