Integración de event streaming

Se necesita ayuda del desarrollador

Necesitará la ayuda de su equipo de desarrollo para configurar la integración. Por favor, comparta esta guía con ellos.

Descripción general de la integración

Tipo de integración

Fuente: Los datos se envían desde Pushwoosh a su sistema a través de HTTP o gRPC según los disparadores de eventos configurados.

¿Cómo funciona la integración?

Pushwoosh transmite datos de eventos de comunicación (p. ej., actividad de push/email) a un endpoint definido por el cliente. Los datos se envían en flujos por lotes a intervalos programados o al alcanzar un tamaño mínimo de lote.

Los datos solo se envían si coinciden con los eventos, plataformas y filtros opcionales seleccionados (códigos de campaña/mensaje, live activity). El endpoint del cliente debe estar listo para recibir y, opcionalmente, responder con un estado.

Glosario

URL del endpoint: Endpoint del lado del servidor que permite recibir solicitudes. El cliente puede especificar un puerto si es necesario.

Ejemplos:

• https://clientdomainname.com/webhook_endpoint
• https://clientdomainname.com:8081/webhook_endpoint

Lista de entidades sincronizadas

• Eventos de estadísticas de comunicación (p. ej., Push Enviado, Email Entregado)

Casos de uso

• Seguimiento de la interacción en tiempo real

  Supervise las interacciones de los usuarios, como el envío de un push, la apertura de un email o la entrega de un mensaje, a medida que ocurren, lo que permite una visibilidad inmediata del rendimiento de la campaña.

• Integración con análisis externos

  Transmita eventos a plataformas de análisis de terceros para la generación de informes y análisis centralizados.

• Flujos de trabajo de usuario automatizados

  Desencadene acciones en sistemas externos (como CRM o herramientas de automatización de marketing) basadas en los comportamientos de los usuarios, p. ej., enviar un mensaje de seguimiento cuando un usuario abre un email.

Configuración de la integración

Para configurar la integración:

1. En su cuenta de Pushwoosh, vaya a Settings > 3rd party Integrations, busque Event streaming integration y haga clic en Configure.

2. En la ventana que se abre, complete los campos necesarios.

Ingrese la URL del endpoint

En el campo Endpoint URL, ingrese la URL completa donde se enviarán los eventos, incluido el protocolo y el puerto si corresponde.

Ejemplo

• https://clientdomainname.com/webhook_endpoint
• https://clientdomainname.com:8081/webhook\_endpoint

Seleccione eventos

En el menú desplegable Events, seleccione al menos un evento. Si no se selecciona ninguno, la validación fallará. La lista de eventos es gestionada por el backend y puede cambiar con el tiempo.

Proporcione las credenciales de autorización

Si su servidor lo requiere, ingrese el valor completo para el encabezado Authorization en el campo Authorization.

Ejemplos:

• Bearer your_token_here

• Basic base64encoded_credentials

Nota

El valor se inserta tal cual en el encabezado Authorization (HTTP) o en los metadatos de gRPC. Asegúrese de que haya un espacio entre el esquema de autenticación y el token.

Elija el tipo de transporte

En el menú desplegable Transport type, elija el protocolo de entrega para la transmisión de eventos: HTTP o gRPC. Cada uno tiene un comportamiento y una configuración específicos.

HTTP

Con el tipo de transporte HTTP, Pushwoosh envía datos en lotes según una de las siguientes condiciones:

• Al menos 100 eventos están listos para ser enviados, o

• Ha pasado una hora desde la última transmisión.

Después de enviar los datos, la conexión se cierra una vez que se recibe una respuesta exitosa.

Si el servidor responde con un error 5xx, Pushwoosh reintentará la solicitud de acuerdo con la política de reintentos definida.

Mecanismo de reintento

Intento	Retraso
1º	1 segundo
2º	3 segundos después del 1er intento
3º	8 segundos después del 2º intento

Si todos los reintentos fallan, la solicitud se descarta.

Tiempo de espera

El tiempo de espera predeterminado para una solicitud es de 30 segundos. Esto se puede personalizar a pedido a través del soporte.

Ver ejemplo

gRPC

El tipo de transporte gRPC utiliza streaming bidireccional para la transmisión de datos. Obtenga más información en la documentación de gRPC.

Se abre un stream cuando se cumple una de las siguientes condiciones:

• Al menos 1,000 eventos están listos para su entrega
• Ha pasado una hora desde que se abrió el último stream

El stream se cierra después de que se envían los eventos. Esto asegura que no se abra un nuevo stream para cada evento individual en un corto período de tiempo.

Ver especificación de protobuf

Mecanismo de reintento Cada evento incluye un uuid único. Si un evento falla:

1. La respuesta debe incluir un status diferente de "Success"
2. Se debe incluir el uuid original de la solicitud

Pushwoosh reintentará la entrega basándose en esta respuesta.

Configuración de la conexión

Las opciones avanzadas como TLS, keep-alive o políticas de reintento se configuran manualmente a través del soporte y pueden requerir la participación del equipo de desarrollo.

Seleccione plataformas

En la sección Platforms, seleccione al menos una plataforma para activar el event streaming.

Las plataformas compatibles incluyen:

• iOS, Android, macOS, Windows, Amazon, Safari
• Chrome, Firefox, Internet Explorer, Baidu, Huawei
• Email, SMS, Line, Xiaomi, WhatsApp

Configure filtros avanzados

En la sección Advanced filters, refine los criterios de entrega de eventos utilizando filtros:

• Eventos de live activity: Habilite para recibir eventos de live activity. Estos eventos contienen solo metadatos que incluyen live_activity_id.

• Filtros de campaña: Filtre por código de campaña. Solo se entregarán los eventos vinculados a estas campañas.

• Filtros de mensaje: Filtre por código de mensaje. Solo se entregarán los eventos vinculados a estos mensajes.

Después de completar todos los campos requeridos, haga clic en el botón Apply para guardar y activar su integración.

Nota

Los cambios de configuración entrarán en vigor en un plazo de 15 minutos después de su envío.

Consejo

Para configuraciones avanzadas como tiempos de espera personalizados o configuraciones de gRPC, por favor contacte con el soporte.

Detalles de la solicitud y ejemplo

Endpoint	https://exampleclientendpoint.com/webhook_endpoint
Solicitud HTTP	POST
Autenticación	No
Tipo de solicitud	Fuente
Significado de la solicitud	Enviar solicitudes al endpoint del webhook
Encabezados	Content-Type: application/json

Ejemplo de cuerpo de la solicitud

{
  "event_name": "Email Opened",
  "message_code": "E682-E6D92B9A-53E24868",
  "campaign_id": 961048,
  "platform": "Email",
  "payload": "Welcome to Headway! 👋",
  "application_code": "XXXXX-XXXXX",
  "hwid": "user@example.com",
  "user_id": "USER_ID",
  "timestamp": 1723799271,
  "journey_title": "",
  "journey_point_title": "5_Welcome_ID_new"
}

Respuesta Por el momento, el código de respuesta y el cuerpo se ignoran.

¿Cómo saber si la integración está funcionando?

Comenzará a recibir solicitudes de Pushwoosh en su endpoint configurado.