Comprender los webhooks en Advanced KDP

Objetivos del artículo

Aprende sobre 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 cómo trabajar con webhooks del sistema.

This content requires Functional cookies to be enabled.

Update Cookie Settings

¿Qué son los webhooks?

Los webhooks permiten a Klaviyo transferir información o “llamar” a otras aplicaciones, herramientas y servidores mediante solicitudes HTTP. Pueden enviar información sobre un evento que ocurrió (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. Webhooks 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 gama de eventos sin las limitaciones de estar en un flujo.
2. Webhooks de flujo
   Los webhooks de flujo son acciones dentro de los flujos. Envían datos cuando un perfil llega a la acción de webhook y pueden incluir información sobre ese perfil o sobre el evento 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 webhook en Advanced Klaviyo Data Platform o webhooks de flujo según tus necesidades.

Eventos incluidos

En los flujos activados por métricas, los webhook de flujo solo pueden responder a eventos compatibles como activadores de flujo. Por ejemplo, Received Email y Clicked Email no están disponibles en el selector de activadores de métricas, mientras que Cancelar la suscripción del marketing por correo electrónico sí es compatible. Los webhook del sistema en Advanced Klaviyo Data Platform te permiten seleccionar temas para eventos relacionados con mensajes, así como eventos de integraciones y la interfaz de programación de aplicaciones (API) de Klaviyo.

Entre ellos, se incluyen los siguientes:

• Eventos de correo electrónico (p. ej., Correo electrónico recibido, Se hizo clic en el correo electrónico, Se marcó el correo electrónico como spam, Se canceló la suscripción al marketing por correo electrónico)
• 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 de primera parte 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 flujo te permiten personalizar los datos de la solicitud mediante la configuración de un cuerpo JSON. Los webhooks del sistema en Advanced Klaviyo Data Platform usan una carga útil prediseñada con datos sobre los eventos que ocurrieron. Una sola solicitud puede incluir varios eventos de los temas que seleccionaste.

Limitaciones del flujo

Los webhooks del flujo siguen el activador y los pasos del flujo que los contiene. Usa flujos separados para responder a diferentes activadores de flujo. La acción de webhook debe estar en Live para enviar solicitudes automáticamente; una acción en Draft no envía solicitudes. Los webhooks del sistema se ejecutan fuera de los flujos y pueden suscribirse a varios temas en 1 punto de conexión.

Configurar webhook

1. Ve a Administración de datos > Webhooks en Klaviyo.
2. Haz clic en Crear webhook.
3. En la página Crear webhook, ingresa la siguiente información:
   • 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
     Ingresa una clave secreta de 16–100 caracteres. Klaviyo usa esta clave para firmar solicitudes, de modo que tu aplicación receptora pueda verificar que provienen de Klaviyo.
   • Descripción
     Una descripción opcional para tu webhook.
4. En Temas, selecciona 1 o más temas que deban activar notificaciones. Por ejemplo, event:klaviyo.received_email corresponde a Correo electrónico recibido.

5. Opcional: Prueba la conexión con los pasos de Probar webhooks del sistema a continuación antes de guardar.
6. Haz clic en Guardar para crear el webhook. Klaviyo te devuelve a la página webhooks.

Después de guardar, el webhook aparece en la página de webhooks con los siguientes detalles:

• Nombre del webhook
• URL del punto de conexión (acortada por seguridad)
• Estado

Para dejar de enviar notificaciones, abre el menú junto al webhook y selecciona Deshabilitar. Para eliminarlo, selecciona Eliminar y confirma la eliminación.

Probar webhooks del sistema

1. Después de completar los campos obligatorios en la página Crear webhook y seleccionar los temas, haz clic en Probar conexión.

2. En el panel Probar webhook, selecciona un tema en Temas y luego haz clic en Probar para enviar una solicitud de muestra a la URL del punto de conexión.

3. Revisa el mensaje que indica si la prueba se realizó correctamente. La pestaña Solicitud muestra los encabezados y la carga útil enviados a tu punto de conexión. La pestaña Respuesta muestra los encabezados de respuesta, el cuerpo y el código de estado del punto de conexión.

1. Haz clic en Cancelar para cerrar el panel de prueba y volver a la configuración del webhook.

Ejemplo de carga útil

A continuación se muestra un payload de ejemplo para una solicitud activada por Received Email (event:klaviyo.received_email).

{
  "meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2024-06-28",
    "klaviyo_payload_id": "3843971dcfdee5083e6289e1bbdbb003e538b5a8a668fc43ae4f19d415ac18a2",
    "klaviyo_account_id": "ACCOUNT_ID"
  },
  "data": [
    {
      "topic": "event:klaviyo.received_email",
      "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