Comprender los webhooks en Advanced KDP

Objetivos del artículo

Conoce los webhooks y cómo puedes usarlos para enviar información a tus aplicaciones de terceros en respuesta a 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 webhooks?

Los webhooks permiten que Klaviyo transmita información o “llame” a otras aplicaciones, herramientas y servidores mediante solicitudes HTTP. Pueden enviar información sobre un evento que ha ocurrido (p. ej., un pedido realizado, un nuevo cliente se suscribió, etc.) o notificar a tus sistemas externos que el evento ocurrió.

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 ocurrió un evento específico y te permiten enviar información en respuesta a una amplia variedad de eventos sin las limitaciones de estar en un flujo.
2. Webhook del flujo
   Los webhook del flujo solo están disponibles dentro de la interfaz de flujos y se activan cuando el flujo llega a una determinada etapa o paso. Se pueden usar para enviar datos sobre el evento o el destinatario que activó el flujo.

Componentes clave de los webhook

Los webhook se componen de algunos 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 webhooks en Advanced Klaviyo Data Platform de los webhooks de flujo?

Puedes usar webhooks en Advanced KDP o webhooks de flujos según tus necesidades.

Eventos incluidos

Los webhook de flujo solo pueden responder a un subconjunto de eventos de Klaviyo y no admiten eventos relacionados con mensajes como cancelar la suscripción, Correo electrónico recibido o Correo electrónico con clic, ya que los flujos suelen terminar con la recepción del mensaje en lugar de comenzar con ella. Mientras tanto, los webhook en Advanced Klaviyo Data Platform te permiten enviar información en respuesta a cualquier evento de tu cuenta.

Entre ellos, se incluyen los siguientes:

• Eventos de correo electrónico (p. ej., Correo electrónico recibido, Correo electrónico en el que se hizo clic, Correo electrónico marcado como spam, cancelar la suscripción)
• Eventos de SMS (p. ej., SMS enviados, SMS recibidos)
• Eventos de notificación push (p. ej., Notificación push recibida, Notificación push rebotada)
• Eventos de integraciones (es decir, eventos de integraciones propias creadas por Klaviyo)
• Eventos de interfaz de programación de aplicaciones (API) (p. ej., eventos sincronizados a través de las interfaces de programación de aplicaciones (API) de Klaviyo)

Carga útil

Los webhooks de flujos 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 un payload predefinido que no requiere ningún trabajo manual de tu parte y se usan para notificar a sistemas externos que ocurrió un evento.

Limitaciones del flujo

Los webhooks de flujo deben configurarse dentro de la interfaz de flujos y no te permiten usar varios activadores al mismo tiempo. Los diferentes activadores deben crearse mediante flujos individuales y dependen del estado general del flujo (por ejemplo, un flujo en borrador no enviaría datos a través del webhook del flujo). Mientras tanto, los webhooks en 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 del webhook, como un webhook de flujo.

Configurar webhook

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

Para agregar un nuevo webhook, haz clic en el botón Crear webhook.

1. En el modal Crear un webhook, ingresa la información. Esto incluye lo siguiente:
   • Nombre
     Cómo identificarás tu webhook
   • URL del punto de conexión
     La URL asociada con el destino de la solicitud del webhook
   • Clave secreta
     Un identificador único para identificar 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 quieras que activen la notificación de webhook

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

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

Puedes eliminar o deshabilitar tu webhook usando el menú junto al elemento.

Probar webhooks del sistema

Al configurar un webhook en Klaviyo, puedes probarlo para asegurarte de que la conexión sea exitosa. Para probar tu webhook, usa el botón Probar conexión después de ingresar los campos obligatorios.

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

Después de ejecutar la prueba, verás un mensaje que indica si fue exitosa, junto con el encabezado y el cuerpo de la solicitud completados en la pestaña Respuesta.

Ejemplo de carga útil

A continuación se muestra un ejemplo de la carga útil de una solicitud de webhook en respuesta al tema Correo electrónico entregado.

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