Capire i webhook all'interno di Advanced KDP
Cosa imparerai
Scopri i webhook e come puoi usarli per inviare informazioni alle tue applicazioni di terze parti in risposta agli eventi acquisiti in Klaviyo. Per informazioni più dettagliate su come ricevere i webhook di sistema, vai alla nostra risorsa per sviluppatori su lavorare con i webhook di sistema.
Advanced Klaviyo Data Platform non è incluso nell'applicazione di marketing standard di Klaviyo e per accedere alle funzionalità associate è necessario un abbonamento. Visita la nostra guida alla fatturazione per scoprire come acquistare questo piano.
Che cosa sono i webhook?
I webhook consentono a Klaviyo di trasmettere informazioni o "chiamare" altre applicazioni, strumenti e server tramite richieste HTTP. Possono inviare informazioni su un evento che si è verificato (ad es. un ordine effettuato, un nuovo cliente iscritto, ecc.) oppure notificare ai tuoi sistemi esterni che l'evento si è verificato.
Klaviyo supporta 2 tipi di webhook:
- Webhook all'interno di Advanced KDP
I webhook disponibili all'interno di Advanced KDP sono utilizzati per notificare ai tuoi sistemi esterni il verificarsi di un particolare evento e ti permettono di inviare informazioni in risposta a una vasta gamma di eventi senza le limitazioni di un Flusso. - Webhook del flusso
I webhook del flusso sono disponibili solo all’interno dell’interfaccia dei flussi e vengono attivati quando il flusso raggiunge una determinata fase o passaggio. Possono essere utilizzati per inviare dati sull’evento o sul destinatario che ha attivato il flusso.
Componenti chiave dei webhook
I webhook sono composti da alcuni componenti chiave:
- Argomento
L'evento che fa scattare un webhook - Corpo (o "payload")
I dati che il webhook invia - Intestazioni
Uno spazio per passare informazioni aggiuntive (come l'autenticazione)
In che modo i webhook di Advanced KDP differiscono dai webhook del flusso?
Puoi utilizzare i webhook in Advanced KDP o i webhook del flusso a seconda delle tue esigenze.
Eventi inclusi
I webhook del flusso possono rispondere solo a un sottoinsieme di eventi di Klaviyo e non assistono gli eventi relativi ai messaggi come annullare l'iscrizione, e-mail ricevute o e-mail cliccate, poiché Flusso generalmente termina con la ricezione del messaggio piuttosto che iniziare con essi. Nel frattempo, i webhook di Advanced KDP ti permettono di inviare informazioni in risposta a qualsiasi evento del tuo account.
Tra questi rientrano:
- Eventi e-mail (ad esempio, E-mail ricevute, E-mail cliccate, E-mail contrassegnate come spam, annullare l'iscrizione)
- Eventi SMS (ad esempio SMS inviato, SMS ricevuto)
- Eventi notifiche push (ad esempio, push ricevuta, push rimbalzata)
- Eventi dalle integrazioni (ovvero, eventi dalle integrazioni first-party create da Klaviyo)
- Eventi API (ad es., eventi sincronizzati tramite le API di Klaviyo)
Payload
I webhook del flusso ti permettono di personalizzare i dati inclusi nella richiesta, ma devi costruire manualmente il payload. Nel frattempo, i webhook di Advanced KDP utilizzano un payload precostituito che non richiede alcun lavoro manuale da parte tua e vengono utilizzati per notificare ai sistemi esterni il verificarsi di un evento.
Limitazioni del flusso
I webhook del flusso devono essere configurati all'interno dell'interfaccia di Flusso e non consentono di utilizzare più trigger contemporaneamente. I diversi trigger devono essere creati attraverso i singoli Flussi e dipendono dallo stato generale del Flusso (ad esempio, un Flusso in bozza non invierà dati attraverso il Flusso webhook). Nel frattempo, i webhook in Advanced KDP esistono al di fuori dell'interfaccia di Flusso e non dipendono dalla serie di passaggi che portano all'azione webhook come un Flusso webhook.
Imposta webhook
Per impostare un webhook in Klaviyo, vai alla voce webhook in Advanced KDP > data managment > webhook in Klaviyo.
Per aggiungere un nuovo webhook, fai clic sul pulsante Crea webhook.
- Nella finestra modale Crea un webhook, inserisci le informazioni. Questo include:
- Nome
Ecco come identificare il tuo webhook - URL endpoint
L'URL associato alla destinazione della richiesta webhook - Chiave segreta
Un identificatore univoco per identificare le richieste webhook di Klaviyo negli altri sistemi - Descrizione
Una descrizione facoltativa per il tuo webhook.
- Nome
- Nella sezione Argomenti, scegli gli eventi che vuoi usare per attivare la notifica webhook
L’URL di callback deve:
- Essere in un formato URL valido
- Inizia con HTTPS://
- Non avere un certificato SSL autofirmato
- Non reindirizzare a un altro URL
Una volta creato il webhook, verrà elencato nella pagina Webhook insieme a:
- Nome del webhook
- URL del webhook
- Ora dell'ultima sincronizzazione
- Stato
Nota che possono essere necessari fino a 15 minuti prima che il webhook inizi a inviare all’URL.
Puoi eliminare o disattivare il webhook usando il menu accanto all’elemento.
Testa i webhook di sistema
Quando configuri un webhook in Klaviyo, puoi testarlo per assicurarti che la connessione sia riuscita. Per testare il webhook, usa il pulsante Testa connessione dopo aver inserito i campi obbligatori.
Verrà visualizzato un menu in cui puoi selezionare un argomento e inviare un test al tuo URL di callback.
Dopo aver eseguito il test, vedrai un messaggio che indica se ha avuto esito positivo, insieme a intestazione e corpo della richiesta compilati nella scheda Risposta.
Per verificare che una notifica webhook provenga da Klaviyo, usa la chiave segreta che hai creato per identificare la richiesta.
Payload di esempio
Di seguito è riportato un esempio del payload per una richiesta webhook in risposta all'argomento E-mail consegnata.
Tieni presente che il payload può essere diverso in base ai dati specifici del tuo account.
{
"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/"
}
}
}
}
}
},
Risorse aggiuntive
- Come funzionano i webhook nei flussi
Scopri i webhook nei flussi e come inviano informazioni da Klaviyo ai tuoi strumenti e applicazioni di terze parti. È importante notare che configurare i webhook può essere complesso. È consigliabile avere conoscenze di sviluppo o risorse di sviluppo per completare correttamente questa configurazione. Se stai cercando queste indicazioni di sviluppo, scopri come aggiungere un’azione webhook a un flusso.