Entender el webhook en la Plataforma Avanzada de Datos Klaviyo

Qué aprenderás

Aprenda sobre webhooks, y cómo puede utilizarlos para enviar información a sus aplicaciones de terceros en respuesta a eventos capturados en Klaviyo. Para obtener información más detallada sobre cómo recibir webhooks del sistema, diríjase a nuestro recurso para desarrolladores sobre cómo trabajar con webhooks del sistema.

¿Qué son los webhooks?

Los webhooks permiten a Klaviyo pasar información o "llamar" a otras aplicaciones, herramientas y servidores a través de peticiones HTTP. Pueden enviar información sobre un acontecimiento que se ha producido (por ejemplo, un pedido realizado, la suscripción de un nuevo cliente, etc.) o notificar a sus sistemas externos que el acontecimiento se ha producido.

Klaviyo soporta 2 tipos de webhooks:

1. webhook en la Plataforma de Datos Avanzada Klaviyo
   Los webhook disponibles como parte de la Plataforma de Datos Avanzada Klaviyo se utilizan para notificar a tus sistemas externos que se ha producido un evento concreto, y te permiten enviar información en respuesta a una amplia gama de eventos sin las limitaciones de estar en un flujo.
2. webhook de flujo
   Los webhooks de flujo solo están disponibles dentro de la interfaz de flujo y se activan cuando el flujo alcanza una determinada etapa o paso. Se pueden utilizar para enviar datos sobre el evento o los destinatarios que han activado el flujo.

Componentes clave de los webhooks

Los webhooks están formados por unos pocos componentes clave:

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

¿En qué se diferencian los webhook de la Plataforma de Datos Avanzada Klaviyo de los webhook de flujo?

Puedes utilizar webhook en la Plataforma de Datos Avanzada Klaviyo o webhook de flujo en función de tus necesidades.

Eventos incluidos

El webhook de flujo sólo puede responder a un subconjunto de eventos de Klaviyo, y no asiste a eventos relacionados con mensajes como darse de baja, correo electrónico recibido o correo electrónico pulsado, ya que el flujo generalmente termina con la recepción del mensaje en lugar de comenzar con ellos. Mientras tanto, los webhooks de la Plataforma de Datos Avanzada Klaviyo te permiten enviar información en respuesta a cualquier evento de tu cuenta.

Entre ellos se incluyen:

• Eventos de correo electrónico (por ejemplo, correo electrónico recibido, correo electrónico pulsado, correo electrónico marcado como spam, anulación de suscripción)
• Eventos SMS (por ejemplo, SMS enviados, SMS recibidos)
• Eventos de notificación push (por ejemplo, push recibido, push rebotado)
• Eventos de integraciones ( es decir, eventos de integraciones de primera parte creadas por Klaviyo)
• API eventos (por ejemplo, eventos sincronizados a través de la API deKlaviyo)

Carga útil

flujo webhook te permite personalizar los datos incluidos en la solicitud, pero debes construir manualmente la carga útil. Mientras tanto, los webhooks de la Plataforma de Datos Avanzada Klaviyo utilizan una carga útil preconstruida que no requiere ningún trabajo manual por tu parte, y se utilizan para notificar a sistemas externos que se ha producido un evento.

Limitaciones de caudal

El webhook de flujo debe configurarse dentro de la interfaz de flujo y no permite utilizar varios desencadenadores a la vez. Se deben crear diferentes desencadenantes a través de flujos individuales, y estos dependen del estado general del flujo (por ejemplo, un flujo en borrador no enviaría datos a través del flujo webhook). Mientras tanto, los webhooks de la plataforma de datos avanzada de Klaviyo existen fuera de la interfaz de flujo y no dependen de la serie de pasos que conducen a la acción « webhook » (Añadir a la lista de correo), como un flujo webhook.

Configurar webhooks

Para configurar un webhook en Klaviyo, navega hasta webhook en Advanced Klaviyo Data Platform > data managment > webhook en Klaviyo.

Para añadir un nuevo webhook, pulse el botón Crear webhook.

1. En el modal Crear un webhook, introduzca la información. Esto incluye:
   • Nombre
     Cómo identificará su webhook
   • URL de conexión
     La URL asociada con el destino de la solicitud webhook.
   • Clave secreta
     Un identificador único para identificar Klaviyo webhook solicitudes en sus otros sistemas.
   • Descripción
     Una descripción opcional para su webhook.
2. En la sección Temas, seleccione los eventos que desea que activen la notificación del webhook.

Una vez que haya creado su webhook, aparecerá en la página de Webhooks junto con el:

• Nombre del webhook
• URL del webhook
• Hora de la última sincronización
• Estado

Puede eliminar o desactivar su webhook utilizando el menú situado junto al elemento.

Probar los webhooks del sistema 

Al configurar un webhook en Klaviyo, puede probarlo para asegurarse de que la conexión es correcta. Para probar su webhook, utilice el botón Probar conexión después de rellenar los campos obligatorios.

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

Tras realizar la prueba, verá un mensaje indicando si ha tenido éxito, junto con la cabecera y el cuerpo de la solicitud rellenados en la pestaña Respuesta.

Ejemplo de carga útil

A continuación se muestra un ejemplo de la carga útil para 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"
  },
 " datos": [
 {
 " tema": "evento: correo",
 " external_id": "ID",
 " payload": {
 " datos": {
 " id": "ID",
 " type": "event",
 " links": {
            "self": "https://a.klaviyo.com/api/events/ID/"
          },
 " atributos": {
 " uuid: "96150200-374e-11ee-8001-a163313bc6c2",
 " datetime": "2023-08-10 07:21:56+00:00",
 " timestamp": 1691652116 ,
 " event_properties": {
 " $ESP": 0,
 " Asunto": "? Alerta Swag gratuita (¡Genial!)",
 " $message": "01H7F525FKR31P27Y7PNGVBBKK",
 " $event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
 " $group_ids": [
 " V7adxq"
 ],
 " $attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
 " correo Dominio": "Klaviyo-demo.com",
              campaña Name": "Boletín diario: 2023-08-10",
 " Inbox proveedor": "Amazon SES Inbound",
 " $_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKKK"
 }
         },
 " relaciones": {
 " métrica": {
 " datos": {
                "id": "ID",
                "type": "metric"
              },
 " enlaces": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
                "related": "https://a.klaviyo.com/api/events/ID/metric/"
              }
            },
 " perfil": {
 " datos": {
                "id": "ID",
                "type": "profile"
              },
 " enlaces ": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
                "related": "https://a.klaviyo.com/api/events/ID/profile/"
              }
            }
          }
        }
      }
    },
  

Recursos adicionales

Cómo añadir una acción webhook a un Flow

Comprender los webhooks de Klaviyo

Trabajar con webhooks del sistema (API de Webhooks de Klaviyo)