Entenda o webhook no Advanced Klaviyo Data Platform

O que você vai aprender

Saiba mais sobre webhooks e como usá-los para enviar informações a aplicativos de terceiros em resposta a eventos capturados no Klaviyo. Para obter informações mais detalhadas sobre como receber webhooks do sistema, consulte nosso recurso para desenvolvedores sobre como trabalhar com webhooks do sistema.

O que são webhooks?

Os webhooks permitem que o Klaviyo passe informações ou "chame" outros aplicativos, ferramentas e servidores por meio de solicitações HTTP. Eles podem enviar informações sobre um evento que ocorreu (por exemplo, um pedido feito, um novo cliente inscrito etc.) ou notificar seus sistemas externos de que o evento ocorreu.

O Klaviyo suporta dois tipos de webhooks:

1. webhook no Advanced Klaviyo Data Platform
   O webhook disponível na Advanced Klaviyo Data Platform é usado para notificar seus sistemas externos sobre a ocorrência de um determinado evento e permite que o senhor envie informações em resposta a uma ampla gama de eventos sem as limitações de um fluxo.
2. Webhooks de fluxo
   Os webhooks de fluxo só estão disponíveis na interface de fluxos e são acionados quando o fluxo atinge um determinado estágio ou etapa. Eles podem ser usados para enviar dados sobre o evento ou destinatário que acionou o fluxo.

Principais componentes dos webhooks

Os webhooks são feitos de alguns componentes principais:

• Tópico
  O evento que faz com que um webhook seja acionado
• Corpo (ou "a carga útil")
  Os dados que o webhook envia.
• Cabeçalhos
  Um local para passar informações adicionais (como autenticação)

Qual é a diferença entre o webhook da Advanced Klaviyo Data Platform e o webhook do fluxo?

O senhor pode usar o webhook na Advanced Klaviyo Data Platform ou o webhook do fluxo, dependendo de suas necessidades.

Os eventos incluíram

O webhook do fluxo só pode responder a um subconjunto de eventos do Klaviyo e não suporta eventos relacionados a mensagens, como cancelamento de inscrição, e-mail recebido ou e-mail clicado, pois o fluxo geralmente termina com o recebimento da mensagem em vez de começar com eles. Enquanto isso, o webhook na Advanced Klaviyo Data Platform permite que o senhor envie informações em resposta a qualquer evento em sua conta.

tais como:

• Eventos de e-mail (por exemplo, e-mail recebido, e-mail clicado, e-mail marcado como spam, cancelamento de assinatura)
• Eventos de SMS (por exemplo, SMS enviado, SMS recebido)
• Eventos de notificação por push (por exemplo, Received push, Bounced push)
• Eventos de integrações (ou seja, eventos de integrações primárias criadas pela Klaviyo)
• Eventos de API (por exemplo, eventos sincronizados por meio das APIs da Klaviyo)

Carga útil

O webhook do fluxo permite que o senhor personalize os dados incluídos na solicitação, mas é necessário construir manualmente a carga útil. Enquanto isso, o webhook na Advanced Klaviyo Data Platform usa uma carga útil pré-construída que não exige nenhum trabalho manual da sua parte e é usado para notificar sistemas externos sobre a ocorrência de um evento.

Limitações de fluxo

O webhook do fluxo deve ser configurado na interface do fluxo e não permite que o senhor use vários acionadores ao mesmo tempo. Diferentes acionadores devem ser criados por meio de fluxos individuais e dependem do status geral do fluxo (por exemplo, um fluxo em rascunho não enviaria dados por meio do fluxo webhook). Enquanto isso, o webhook na Advanced Klaviyo Data Platform existe fora da interface do fluxo e não depende da série de etapas que levam à ação webhook como um fluxo webhook.

Configurar webhooks

Para configurar um webhook em Klaviyo, navegue até o webhook em Advanced Klaviyo Data Platform > dados managment > webhook em Klaviyo.

1. Para adicionar um novo webhook, clique no botão Create webhook (Criar webhook ).
2. No modal Create a webhook (Criar um webhook ), insira as informações. Isso inclui:
• Nome
  Como o senhor identificará o webhook.
• URL do ponto de extremidade
  O URL associado ao destino da solicitação do webhook.
• Chave secreta
  Um identificador exclusivo para identificar as solicitações de webhook do Klaviyo em seus outros sistemas.
• Descrição
  Uma descrição opcional para seu webhook.
3. Na seção Tópicos, escolha os eventos que deseja acionar a notificação do webhook.

Depois que o senhor criar o webhook, ele será listado na página Webhooks, juntamente com os outros:

• Nome do webhook
• URL do webhook
• Hora da última sincronização
• Status

O senhor pode excluir ou desativar o webhook usando o menu ao lado do item.

Testar webhooks do sistema 

Ao configurar um webhook no Klaviyo, o senhor pode testá-lo para ter certeza de que a conexão foi bem-sucedida. Para testar seu webhook, use o botão Testar webhook depois de inserir os campos obrigatórios.

Será exibido um menu no qual o senhor poderá selecionar um tópico e enviar um teste para o seu URL de retorno de chamada. 

Depois de executar o teste, o senhor verá uma mensagem indicando se ele foi bem-sucedido, juntamente com o cabeçalho e o corpo da solicitação preenchidos na guia Response (Resposta ).

Exemplo de carga útil

Abaixo está um exemplo da carga útil de uma solicitação de webhook em resposta ao tópico E-mail entregue. 

{
 " meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2023-06-03"
  },
 " data": [
 {
 " topic": "event: E-mail",
 " 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": "? Alerta de Swag grátis (legal!) ?",
 " $message": "01H7F525FKR31P27Y7PNGVBBKK",
 " $event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
 " $group_ids": [
 " V7adxq"
 ],
 " $attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
 " Domínio de e-mail": "Klaviyo-demo.com",
              Campanha Name": "Newsletter diário: 2023-08-10",
 " Inbox fornecedor": "Amazon SES Inbound",
 " $_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
 } }.
         },
 " relacionamentos": {
 " métrica": {
 " 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/"
              }
            },
 " perfil": {
 " 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/"
              }
            }
          }
        }
      }
    },
  

Recursos adicionais

Como adicionar uma ação de webhook a um fluxo

Entendendo os webhooks do Klaviyo

Trabalhar com webhooks do sistema (API de webhooks da Klaviyo)