Integración de webhooks entrantes

Los webhooks entrantes permiten que los servicios externos envíen eventos directamente a Pushwoosh. Cuando un sistema de terceros activa un webhook, Pushwoosh autentica la solicitud, identifica al suscriptor y dispara el evento asignado. El evento puede entonces iniciar o hacer avanzar un journey.

Utilice webhooks entrantes para conectar herramientas como CRMs, plataformas de comercio electrónico o servicios de análisis sin construir o mantener su propio servidor. Cada webhook entrante activa un evento de Pushwoosh cuando se recibe y procesa con éxito una solicitud coincidente.

Antes de empezar

Prepare lo siguiente antes de abrir la configuración del webhook.

Decida qué evento de Pushwoosh debe activar el webhook. Elija un evento existente de su proyecto que desee activar desde el servicio de terceros. Por ejemplo, CheckoutSuccess. Si aún no tiene un evento adecuado, cree uno con los atributos que desea rellenar a partir de los datos entrantes.
Asegúrese de que su servicio de terceros pueda enviar webhooks. El servicio debe ser capaz de enviar una solicitud HTTP POST a una URL externa cuando ocurra el evento que le interesa, por ejemplo, un nuevo pedido o el envío de un formulario.
Obtenga una carga útil (payload) JSON de muestra de su servicio de terceros. Este es un pequeño ejemplo de los datos que el servicio envía en cada evento. Lo necesitará para asignar los campos de la carga útil a los atributos del evento de Pushwoosh.

Crear un webhook

En su cuenta de Pushwoosh, vaya a Configuración → Integraciones → Webhooks entrantes y haga clic en Configuración.

Página de integraciones con la tarjeta de Webhooks entrantes y el botón de Configuración para abrir la configuración del webhook

Haga clic en Crear webhook para abrir el flujo de configuración.

Pantalla de creación de webhook con nombre, evento, carga útil de muestra y asignación de identificador de usuario

Introduzca un nombre para el webhook para que pueda identificarlo en la lista más tarde.
Seleccione el evento de Pushwoosh que debe activarse cuando el webhook reciba una solicitud válida. Puede elegir entre los eventos que ya existen en su proyecto. Si necesita crear un evento primero, consulte Eventos.

Pantalla de configuración de webhook con el menú desplegable de eventos de Pushwoosh para seleccionar el evento a activar en la solicitud entrante

En Coincidir datos entrantes, pegue una carga útil (payload) JSON de muestra de su servicio de terceros. Pushwoosh carga los campos de la carga útil en los menús desplegables automáticamente.

Carga útil de muestra:

{
  "user_id": "12345",
  "email_address": "jane@example.com",
  "mobile": "+15551234567",
  "purchase_date": "2024-03-15",
  "order_number": "ORD-001",
  "price": 99.99,
  "payment_state": "success"
}

En Identificar usuarios por, seleccione cómo Pushwoosh debe hacer coincidir la solicitud entrante con un usuario:

ID de usuario: coincide por el ID de usuario interno en Pushwoosh.
Correo electrónico: coincide por la dirección de correo electrónico.
Teléfono: coincide por el número de teléfono.
HWID: coincide por el identificador de dispositivo, navegador o correo electrónico.

En Campo de la carga útil, seleccione el campo que contiene el valor coincidente.

Menús desplegables de Identificar usuarios por y Campo de la carga útil con información sobre herramientas de ID de usuario y HWID en la pantalla de Coincidir datos entrantes

Asigne cada atributo de evento a un campo de la carga útil. En cada fila de asignación:

Atributo del evento: el nombre del atributo en Pushwoosh. Seleccione entre los atributos definidos para este evento.
Campo de la carga útil: el campo de la carga útil entrante que contiene el valor.

Por ejemplo, asigne email a email_address, total a price, y order_id a order_number.

Filas de asignación de Atributo del evento y Campo de la carga útil con carga útil de muestra y el botón Recargar opciones de selección

Haga clic en + Añadir atributo para añadir una fila. Haga clic en × para eliminar una.

Cuando la configuración esté completa, haga clic en Habilitar. Se abrirá la ventana URL del webhook.

Copie los valores y péguelos en la configuración de webhooks de su sistema externo:

Copie la URL y establézcala como el destino del webhook en su servicio de terceros.
Copie el Secreto y péguelo en su servicio externo como el valor del encabezado Authorization. El valor incluye el prefijo Bearer, así que úselo tal cual. Pushwoosh rechaza cualquier solicitud en la que este encabezado falte o no coincida.

Ventana de URL del webhook que muestra los campos de URL y Secreto con botones de copia para la configuración del sistema externo

La ventana también muestra una Solicitud de ejemplo con una solicitud POST de muestra. Haga clic en Copiar en el bloque de ejemplo para copiar la solicitud completa. Úsela para enviar una solicitud de prueba y confirmar que Pushwoosh acepta el webhook, o compártala con su equipo como plantilla para la integración.

Ventana de URL del webhook con URL, Secreto y comando curl de Solicitud de ejemplo para la configuración del sistema externo

Después de habilitar el webhook, aparece en la lista de Webhooks con un estado habilitado y comienza a aceptar solicitudes.

Lista de webhooks

La lista de webhooks entrantes muestra todos los webhooks de su proyecto.

Cada fila muestra:

Nombre: nombre del webhook.
Evento: el evento de Pushwoosh que se activa cuando el webhook recibe una solicitud válida.
Estado: Habilitado o Deshabilitado.
Recibidos: número de solicitudes recibidas por el webhook.
Última actualización: cuándo se modificó el webhook por última vez.

Lista de webhooks entrantes con búsqueda, filtros de estado, columnas de tabla y menú de acciones de fila abierto

Gestionar webhooks

Abra el menú de la fila para:

Editar configuración: abre la configuración del webhook para que pueda cambiar el nombre, el evento, la asignación de campos y la identificación del usuario.
Copiar URL: abre la ventana URL del webhook con la URL y el Secreto para que pueda copiarlos de nuevo.
Registro de actividad: abre el registro de solicitudes para este webhook.
Eliminar: elimina el webhook de la lista.

Para un webhook habilitado, haga clic en Deshabilitar para desactivarlo sin eliminar la configuración. Para un webhook deshabilitado, haga clic en Habilitar para empezar a aceptar solicitudes de nuevo.

Ver el registro de actividad

El registro de actividad muestra todas las solicitudes entrantes para el webhook seleccionado.

Panel de resumen

En la parte superior, revise el resumen de las últimas 24 horas:

Aciertos: número total de solicitudes entrantes recibidas.
Éxito: solicitudes en las que la autenticación fue exitosa, se encontró al usuario y se activó el evento.
Fallidas: solicitudes que no se procesaron. Una solicitud fallida no detiene el webhook. Pushwoosh continúa aceptando y procesando solicitudes posteriores.

Razón del fallo	Qué significa
Autenticación rechazada	El secreto compartido no coincide con la configuración del webhook. Si cinco solicitudes consecutivas fallan con este error, Pushwoosh le enviará una notificación. Actualice el secreto para reanudar. No se necesita reactivación.
Falta el campo identificador de usuario	El campo de la carga útil asignado para la identificación del usuario no está presente en la solicitud.

Entradas de solicitud

Cada entrada muestra el identificador de usuario (por ejemplo, ID de usuario o Correo electrónico), una insignia de Éxito o Fallida, la marca de tiempo de la solicitud y una vista previa de la carga útil JSON recibida. Haga clic en Mostrar para expandir los detalles completos de la solicitud.

Entrada de solicitud del registro de actividad con identificador de usuario, insignia de Éxito o Fallida, marca de tiempo, carga útil JSON y botón Mostrar

Ver eventos activados por webhook en el User Explorer

Cuando una solicitud de webhook se procesa con éxito, Pushwoosh registra el evento en el User Explorer. Dónde aparece depende de cómo haya identificado al usuario:

ID de usuario, Correo electrónico o Teléfono: el evento se registra en el perfil del usuario. Abra el usuario y vaya a Historial de eventos.
HWID: el evento se registra en el dispositivo correspondiente. Abra el usuario, encuentre el dispositivo en Dispositivos de usuario activos y vaya a su pestaña Historial de eventos.

Busque el evento por su nombre y expándalo para ver los atributos asignados (por ejemplo, price o products) y el atributo __webhook con el ID del webhook.

Pestaña de Historial de eventos del User Explorer que muestra un evento de webhook entrante con atributos expandidos, incluyendo el ID __webhook y los campos de la carga útil asignados

Usar webhooks entrantes con journeys

Después de que un webhook esté habilitado y active eventos con éxito, utilice el evento seleccionado como una entrada de journey basada en disparadores. Cuando el webhook recibe una solicitud válida, Pushwoosh activa el evento asignado. Cualquier journey que utilice este evento como disparador de entrada se iniciará automáticamente para el usuario coincidente.