Comprender los webhook en Advanced Klaviyo Data Platform

Qué aprenderás

Descubre los webhooks y cómo puedes utilizarlos para enviar información a tus aplicaciones de terceros en respuesta a los eventos capturados en Klaviyo. Para obtener información más detallada sobre cómo recibir webhooks del sistema, consulta nuestro recurso para desarrolladores sobre trabajar con webhooks del sistema.

This content requires Functional cookies to be enabled.

Update Cookie Settings

¿Qué son los webhook?

Los webhook permiten a Klaviyo transmitir información o «llamar» a otras aplicaciones, herramientas y servidores a través de solicitudes HTTP. Pueden enviar información sobre un evento que ha ocurrido (p. ej., un pedido realizado, un nuevo cliente suscrito, etc.) o notificar a tus sistemas externos que el evento ha ocurrido.

Klaviyo admite 2 tipos de webhook:

1. Webhook en Advanced Klaviyo Data Platform
   Los webhook disponibles como parte de Advanced Klaviyo Data Platform se usan para notificar a tus sistemas externos que se ha producido un evento concreto, y te permiten enviar información en respuesta a una amplia variedad de eventos sin las limitaciones de estar en un flujo.
2. Webhooks de flujo
   Los webhooks de flujo solo están disponibles en la interfaz de flujos y se activan cuando el flujo llega a una determinada etapa o paso. Pueden utilizarse para enviar datos sobre el evento o el destinatario que activó el flujo.

Componentes clave de los webhook

Los webhook se componen de unos pocos componentes clave:

• Tema
  El evento que hace que se active un webhook
• Cuerpo (o «la carga útil»)
  Los datos que envía el webhook
• Encabezados
  Un lugar para pasar información adicional (como autenticación)

¿En qué se diferencian los webhook de Advanced Klaviyo Data Platform de los webhook del flujo?

Puedes usar webhook en Advanced Klaviyo Data Platform o webhook de flujo, según tus necesidades.

Eventos incluidos

Los webhook de los flujos solo pueden responder a un subconjunto de eventos de Klaviyo y no admiten eventos relacionados con mensajes como darse de baja, email recibido o se ha hecho clic en el email, ya que, por lo general, los flujos terminan con la recepción del mensaje en lugar de empezar con ella. Mientras tanto, los webhook de Advanced Klaviyo Data Platform te permiten enviar información en respuesta a cualquier evento de tu cuenta.

Estos eventos incluyen:

• Eventos de email (p. ej., Email recibido, Email en el que se hizo clic, Email marcado como spam, darse de baja)
• Eventos de SMS (p. ej., SMS enviado, SMS recibido)
• Eventos de notificación push (por ejemplo, Notificación push recibida, Notificación push rebotada)
• Eventos de integraciones (es decir, eventos de integraciones de origen creadas por Klaviyo)
• Eventos de API (p. ej., eventos sincronizados a través de las API de Klaviyo)

Carga útil

Los webhook de flujo te permiten personalizar los datos incluidos en la solicitud, pero debes construir manualmente la carga útil. Mientras tanto, los webhook en Advanced Klaviyo Data Platform usan una carga útil predefinida que no requiere ningún trabajo manual por tu parte y se utilizan para notificar a sistemas externos que ha ocurrido un evento.

Limitaciones del flujo

Los webhooks del flujo se deben configurar en la interfaz de flujos y no te permiten usar varios activadores a la vez. Se deben crear diferentes activadores mediante flujos individuales y dependen del estado general del flujo (p. ej., un flujo en borrador no enviaría datos a través del webhook del flujo). Mientras tanto, los webhooks de Advanced Klaviyo Data Platform existen fuera de la interfaz de flujos y no dependen de la serie de pasos que llevan a la acción de webhook, como un webhook del flujo.

Configura webhooks

Para configurar un webhook en Klaviyo, ve a webhook en Advanced Klaviyo Data Platform > Gestión de datos > webhook en Klaviyo.

Para añadir un nuevo webhook, haz clic en el botón Crear webhook.

1. En el modal Crear un webhook, introduce la información. Esto incluye:
   • Nombre
     Así identificarás tu webhook
   • URL del punto de conexión
     La URL asociada al destino de la solicitud del webhook
   • Clave secreta
     Un identificador único para identificar las solicitudes de webhook de Klaviyo en tus otros sistemas
   • Descripción
     Una descripción opcional para tu webhook.
2. En la sección Temas, elige los eventos que te gustaría que activaran la notificación del webhook

Una vez que hayas creado tu webhook, aparecerá en la página Webhooks junto con:

• Nombre del webhook
• URL del webhook
• Hora de la sincronización más reciente
• Estado

Puedes eliminar o desactivar tu webhook mediante el menú situado junto al elemento.

Probar webhooks del sistema

Al configurar un webhook en Klaviyo, puedes probarlo para asegurarte de que la conexión se ha realizado correctamente. Para probar tu webhook, usa el botón Probar conexión después de introducir los campos obligatorios.

Aparecerá un menú en el que puedes seleccionar un tema y enviar una prueba a la URL de devolución de llamada.

Después de realizar la prueba, verás un mensaje que indica si ha sido correcta, junto con el encabezado y el cuerpo de la solicitud, que se completarán en la pestaña Respuesta.

Carga útil de muestra

A continuación, se incluye un ejemplo del payload de una solicitud de webhook en respuesta al tema Email delivered.

{
  "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 adicionales