Capire i webhook nella piattaforma dati avanzata di Klaviyo

Imparerai

Impara a conoscere i webhook e come può utilizzarli per inviare informazioni alle sue applicazioni di terze parti in risposta agli eventi catturati in Klaviyo. Per informazioni più dettagliate su come ricevere i webhook di sistema, consulti la nostra risorsa per sviluppatori sul lavoro con i webhook di sistema.

Cosa sono i webhook?

I webhook permettono a Klaviyo di passare informazioni o di "chiamare" altre applicazioni, strumenti e server tramite richieste HTTP. Possono inviare informazioni su un evento che si è verificato (ad esempio un ordine effettuato, un nuovo cliente iscritto, ecc.) o notificare ai suoi sistemi esterni che l'evento si è verificato.

Klaviyo supporta 2 tipi di webhook:

1. webhook in Advanced Klaviyo Data Platform
   I webhook disponibili all'interno di Advanced Klaviyo Data Platform 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.
2. Webhook del flusso
   I webhook del flusso sono disponibili solo all'interno dell'interfaccia del flusso 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 costituiti da alcuni componenti chiave:

• Argomento
  L'evento che provoca l'attivazione di un webhook
• Corpo (o "il carico utile")
  I dati che il webhook invia.
• Intestazioni
  Un posto dove passare informazioni aggiuntive (come l'autenticazione).

In che modo i webhook di Advanced Klaviyo Data Platform differiscono dai webhook di Flusso?

Puoi utilizzare i webhook in Advanced Klaviyo Data Platform o i webhook di Flusso a seconda delle tue esigenze.

Gli eventi includono

I webhook di 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 della Piattaforma dati avanzata di Klaviyo ti permettono di inviare informazioni in risposta a qualsiasi evento del tuo account.

Questi includono:

• Eventi e-mail (ad esempio, e-mail ricevute, e-mail cliccate, e-mail contrassegnate come spam, disiscrizione)
• Eventi SMS (ad esempio, SMS inviati, SMS ricevuti)
• Eventi di notifica push (ad esempio, push ricevuto, push rimbalzato)
• Eventi da integrazioni (cioè eventi da integrazioni di prima parte create da Klaviyo)
• Eventi API (ad esempio, eventi sincronizzati attraverso le API di Klaviyo)

Carico utile

I webhook di Flusso ti permettono di personalizzare i dati inclusi nella richiesta, ma devi costruire manualmente il payload. Nel frattempo, i webhook di Advanced Klaviyo Data Platform 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 di 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 Klaviyo Data Platform esistono al di fuori dell'interfaccia di Flusso e non dipendono dalla serie di passaggi che portano all'azione webhook come un Flusso webhook.

Impostare i webhook

Per impostare un webhook in Klaviyo, vai alla voce webhook in Advanced Klaviyo Data Platform > data managment > webhook in Klaviyo.

1. Per aggiungere un nuovo webhook, clicchi sul pulsante Crea webhook.
2. Nel modale Crea un webhook, inserisca le informazioni. Questo include:
• Nome
  Come identificherà il suo webhook.
• URL endpoint
  L'URL associato alla destinazione della richiesta webhook.
• Chiave segreta
  Un identificatore unico per identificare le richieste webhook di Klaviyo negli altri sistemi.
• Descrizione
  Una descrizione opzionale per il suo webhook.
3. Nella sezione Argomenti, scelga gli eventi che desidera attivare la notifica webhook.

Una volta creato il suo webhook, sarà elencato nella pagina Webhooks, insieme ai suoi:

• Nome del webhook
• URL del webhook
• Ora dell'ultima sincronizzazione
• Stato

Può eliminare o disattivare il webhook utilizzando il menu accanto alla voce.

Prova i webhook del sistema 

Quando imposta un webhook in Klaviyo, può testarlo per assicurarsi che la connessione abbia successo. Per testare il suo webhook, utilizzi il pulsante Test webhook dopo aver inserito i campi richiesti.

Apparirà un menu in cui potrà selezionare un argomento e inviare un test al suo URL di callback. 

Dopo aver eseguito il test, vedrà un messaggio che indica se è andato a buon fine, insieme all'intestazione e al corpo della richiesta popolati nella scheda Risposta.

Esempio di carico utile

Di seguito è riportato un esempio del payload per una richiesta webhook in risposta all'argomento Email consegnate. 

{
 " meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2023-06-03"
  },
 " dati": [
 {
 " topic": "evento: e-mail",
 " external_id": "ID",
 " payload": {
 " data": {
 " id": "ID",
 " tipo": "evento",
 " link": {
            "self": "https://a.klaviyo.com/api/events/ID/"
          },
 " attributi": {
 " uuid: "96150200-374e-11ee-8001-a163313bc6c2",
 " datetime": "2023-08-10 07:21:56+00:00",
 " timestamp": 1691652116,
 " event_properties": {
 " $ESP": 0,
 " Oggetto": "? Avviso Swag gratuito (cool!)?",
 " $messaggio": "01H7F525FKR31P27Y7PNGVBBKK",
 " $event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
 " $group_ids": [
 " V7adxq"
 ],
 " $attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
 " dominio e-mail": "Klaviyo-demo.com",
              Nome della campagna": "Newsletter giornaliera: 2023-08-10",
 " Provider di posta in arrivo": "Amazon SES Inbound",
 " $_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
 } },  : Newsletter giornaliera : Newsletter giornaliera 
          },
 " relazioni": {
 " metrica": {
 " dati": {
                "id": "ID",
                "type": "metric"
              },
 " collegamenti": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
                "related": "https://a.klaviyo.com/api/events/ID/metric/"
              }
            },
 " profilo": {
 " dati": {
                "id": "ID",
                "type": "profile"
              },
 " link": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
                "related": "https://a.klaviyo.com/api/events/ID/profile/"
              }
            }
          }
        }
      }
    },
  

Risorse aggiuntive

Come aggiungere un'azione webhook a un flusso

Capire i webhook di Klaviyo

Lavorare con i webhook di sistema (API Webhooks di Klaviyo)