Entenda os webhooks na Advanced Klaviyo Data Platform

O que você vai aprender

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

This content requires Functional cookies to be enabled.

Update Cookie Settings

O que são webhooks?

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

A Klaviyo oferece suporte a 2 tipos de webhook:

1. Webhooks na Advanced Klaviyo Data Platform
   Os webhook disponíveis como parte da Advanced Klaviyo Data Platform são usados para notificar seus sistemas externos de que um determinado evento ocorreu e permitem que você envie informações em resposta a uma ampla variedade de eventos, sem as limitações de estar em um fluxo.
2. Webhooks de fluxo
   Os webhooks de fluxo estão disponíveis apenas na interface de fluxos e são acionados quando o fluxo chega a 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 de webhooks

Os webhooks são compostos por alguns componentes principais:

• Tópico
  O evento que faz um webhook disparar
• Corpo (ou "o payload")
  Os dados que o webhook envia
• Cabeçalhos
  Um lugar para passar informações adicionais (como autenticação)

Como os webhooks no Advanced Klaviyo Data Platform diferem dos webhooks de fluxo?

Você pode usar webhook no Advanced Klaviyo Data Platform ou webhooks de fluxo, dependendo das suas necessidades.

Eventos incluídos

Os webhooks de fluxo só podem responder a um subconjunto de eventos do Klaviyo e não oferecem suporte a eventos relacionados a mensagens, como cancelar inscrição, E-mail recebido ou E-mail clicado, já que os fluxos geralmente terminam com o recebimento da mensagem, em vez de começarem por ela. Enquanto isso, os webhooks no Advanced Klaviyo Data Platform permitem que você envie informações em resposta a qualquer evento na sua conta.

como:

• Eventos de e-mail (por exemplo, E-mail recebido, E-mail clicado, E-mail marcado como spam, cancelar inscrição)
• Eventos de SMS (por exemplo, Sent SMS, Received SMS)
• notificação push de eventos (por exemplo, Received push, Bounced push)
• Eventos de integrações (ou seja, eventos de integrações próprias criadas pela Klaviyo)
• Eventos de API (por exemplo, eventos sincronizados por meio das APIs da Klaviyo)

Payload

Os webhook de fluxo permitem que você personalize os dados incluídos na solicitação, mas você precisa construir manualmente o payload. Enquanto isso, os webhook no Advanced Klaviyo Data Platform usam um payload predefinido que não exige nenhum trabalho manual da sua parte e são usados para notificar sistemas externos de que um evento ocorreu.

Limitações de fluxo

Os webhooks de fluxo devem ser configurados na interface de fluxos e não permitem que você use vários gatilhos ao mesmo tempo. Gatilhos diferentes 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 pelo webhook de fluxo). Enquanto isso, os webhooks no Advanced Klaviyo Data Platform existem fora da interface de fluxos e não dependem da série de etapas que antecedem a ação de webhook como um webhook de fluxo.

Configurar webhooks

Para configurar um webhook no Klaviyo, acesse Webhooks em Advanced Klaviyo Data Platform > Gerenciamento de dados > Webhooks no Klaviyo.

Para adicionar um novo webhook, clique no botão Criar webhook.

1. No modal Criar um webhook, insira as informações. Isso inclui:
   • Nome
     Como você vai identificar seu webhook
   • URL do ponto de extremidade
     A URL associada ao destino da solicitação de webhook
   • Chave secreta
     Um identificador exclusivo para identificar solicitações de webhook do Klaviyo nos seus outros sistemas
   • Descrição
     Uma descrição opcional para o seu webhook.
2. Na seção Tópicos, escolha os eventos que você gostaria de usar para acionar a notificação de webhook

Depois que você criar seu webhook, ele será listado na página Webhooks junto com:

• Nome do webhook
• URL do webhook
• Hora da sincronização mais recente
• Status

Você pode excluir ou desativar seu webhook usando o menu ao lado do item.

Testar webhooks do sistema

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

Um menu aparecerá para que você selecione um tópico e envie um teste para o URL de retorno de chamada.

Depois de realizar o teste, você verá uma mensagem indicando se ele foi bem-sucedido, junto com o cabeçalho e o corpo da solicitação preenchidos na aba Resposta.

Payload de exemplo

A seguir, há um exemplo do payload 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: 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/"
              }
            }
          }
        }
      }
    },
  

Recursos adicionais