Entender el webhook en la Plataforma Avanzada de Datos Klaviyo

Objetivos de aprendizaje

Aprende sobre webhook, y cómo puedes utilizarlos para enviar información a tus aplicaciones de terceros en respuesta a eventos capturar en Klaviyo. Para obtener información más detallada sobre cómo recibir el webhook del sistema, dirígete a nuestro recurso para desarrolladores sobre cómo trabajar con el webhook del sistema.

¿Qué son los webhooks?

webhook permiten a Klaviyo pasar información o "llamar" a otras aplicaciones, herramientas y servidores mediante peticiones HTTP. Pueden enviar información sobre un evento que ha ocurrido (por ejemplo, un pedido realizado, un nuevo cliente que se ha suscrito, etc.) o notificar a tus sistemas externos que se ha producido un evento.

Klaviyo equipo de asistencia 2 tipos de webhook:

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. Webhooks de flujo
   Los webhooks de flujo solo están disponibles en la interfaz de flujos y se activan cuando el flujo alcanza una determinada etapa o paso. Se pueden utilizar para enviar datos sobre el evento o el destinatario que ha activado el flujo.

Componentes clave del webhook

webhook están formados por unos pocos componentes clave:

• Tema
  El evento que hace que se dispare un webhook
• Cuerpo (o «la carga útil»)
  Los datos que envía el webhook.
• Cabeceras
  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 equipa de asistencia eventos relacionados con mensajes como cancelar la suscripción, correo electrónico recibido o correo electrónico pulsado, ya que el flujo suele terminar con la recepción del mensaje en lugar de empezar con ellos. Mientras tanto, los webhook 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, cancelar la suscripción)
• Eventos SMS (por ejemplo, SMS enviados, SMS recibidos)
• eventos push de notificación (por ejemplo, push de notificación recibida, push de notificación devuelta)
• Eventos de integraciones (es decir, eventos de integraciones de origen creadas por Klaviyo)
• Eventos API (por ejemplo, eventos sincronizados a través de las API de Klaviyo).

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 del flujo

Los webhooks de flujo deben configurarse en la interfaz de flujos y no permiten utilizar varios desencadenadores a la vez. Se deben crear diferentes desencadenantes a través de 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 de KDP avanzado existen fuera de la interfaz de flujos y no dependen de la serie de pasos que conducen a la acción del webhook, como un webhook de flujo.

Configurar webhook

Para configurar un webhook en Klaviyo, navega hasta webhook en Plataforma de datos Klaviyo avanzada > 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
     Cómo identificará su webhook
   • URL del punto final
     La URL asociada con el destino de la solicitud del webhook.
   • Clave secreta
     Un identificador único para identificar las solicitudes de webhook de Klaviyo en sus otros sistemas.
   • Descripción
     Una descripción opcional para tu webhook.
2. En la sección Temas, seleccione los eventos que desea que activen la notificación del webhook.

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

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

Puedes borrar o desactivar/inhabilitar tu webhook utilizando el menú situado junto al elemento.

Prueba el webhook 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 puedes seleccionar un tema y enviar una prueba a tu URL de devolución de llamada. 

Tras realizar la prueba, verás un mensaje indicando si se ha realizado correctamente, 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 de una solicitud 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: email_entregado",
 " 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 (¡Genial!) gratis ?",
 " $message": "01H7F525FKR31P27Y7PNGVBBKK",
 " $event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
 " $group_ids": [
 " V7adxq"
 ],
 " $attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
 " correo electrónico Dominio": "Klaviyo-demo.com",
              "campaña Nombre": "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/"
              }
            },
 " datos del perfil": {
                "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 flujo

Comprender Klaviyo webhook

Trabajar con el sistema webhook (Klaviyo's webhook interfaz de programación de aplicaciones (API))