Saltar al contenido principal

Introducción

Dispara notificaciones y mensajes automatizados basados en eventos del sistema.

🎯 ¿Qué hace este módulo?​

El módulo de Events te permite configurar notificaciones automatizadas que se activan cuando ocurre algo en tu sistema, como enviar un correo electrónico cuando un producto vuelve a estar en stock, o una notificación push cuando un pedido se envía.

Piénsalo como tu sistema de automatización de notificaciones: tú defines el desencadenante (lo que sucede) y la acción (quién recibe la notificación y cómo).

📖 Explicación Simple​

Imagina que estás administrando una tienda en línea y quieres mantener informados a los usuarios:

  • 📦 Pedido realizado → Enviar correo de confirmación
  • 🚚 Pedido enviado → Enviar notificación push con seguimiento
  • ✅ Producto de nuevo en stock → Notificar a los usuarios que solicitaron alertas
  • 💳 Pago recibido → Enviar correo de recibo
  • 🎉 Nueva promoción → Enviar correo de marketing a los suscriptores
  • ⚠️ Contraseña cambiada → Enviar alerta de seguridad

En lugar de codificar manualmente cada notificación:

  • ✅ Configura eventos en el panel de administración de OneEntry
  • ✅ Define desencadenantes (lo que sucede)
  • ✅ Configura acciones (notificaciones a enviar)
  • ✅ Personaliza mensajes por evento
  • ✅ Realiza un seguimiento de la entrega y el compromiso

Ejemplo del mundo real:

Sin el Módulo de Events (manual):
- Usuario se registra → Escribir código para enviar correo ❌
- Producto reabastecido → Escribir código para notificar a los usuarios ❌
- Cada evento necesita código personalizado ❌

Con el Módulo de Events (automatizado):
- Configurar evento "Usuario Registrado" → Envía automáticamente correo de bienvenida ✅
- Configurar evento "Producto Reabastecido" → Notifica automáticamente a la lista de espera ✅
- Todos los eventos gestionados en un solo lugar ✅

✨ Conceptos Clave​

¿Qué es un Evento?​

Un evento es algo que sucede en tu sistema que puede activar notificaciones:

  • Desencadenante - La acción que inicia el evento (por ejemplo, "pedido realizado")
  • Notificación - Lo que reciben los usuarios (correo, push, mensaje de socket)
  • Destinatarios - Quién recibe la notificación (usuarios específicos, todos los usuarios, administradores)
  • Plantilla - El contenido del mensaje

Tipos de Eventos​

OneEntry admite diferentes tipos de desencadenantes:

Tipo de DesencadenanteCuándo se ActivaEjemplo
Cambio de EstadoCambia el estado de la entidadProducto: Agotado → En Stock
Entidad CreadaSe añade un nuevo ítemNuevo pedido, nuevo registro de usuario
Entidad ActualizadaÍtem modificadoPerfil actualizado, estado del pedido cambiado
Desencadenante PersonalizadoDesencadenante manual desde el códigoBoletín enviado, promoción iniciada

Canales de Notificación​

Tres formas de notificar a los usuarios:

CanalDescripciónMejor Para
CorreoEnviar mensajes de correoConfirmaciones de pedidos, recibos, boletines
Notificación PushAlertas móviles/navegadorActualizaciones en tiempo real, alertas urgentes
Socket.IOMensajes de websocket en tiempo realActualizaciones en vivo, chat, sincronización instantánea

Flujo del Evento​

1. Ocurre algo (Desencadenante)
   ↓
2. El evento detecta el desencadenante
   ↓
3. El evento verifica condiciones (si las hay)
   ↓
4. El evento envía notificaciones
   ↓
5. Los usuarios reciben el mensaje

📋 Lo Que Necesitas Saber​

Desencadenantes de Eventos Comunes​

Eventos típicos que podrías configurar:

E-commerce:

  • Pedido realizado
  • Pedido enviado
  • Pedido entregado
  • Pago recibido
  • Producto de nuevo en stock
  • Alerta de caída de precio

Gestión de Usuarios:

  • Usuario registrado
  • Correo verificado
  • Contraseña cambiada
  • Perfil actualizado
  • Cuenta eliminada

Contenido:

  • Nuevo artículo publicado
  • Comentario añadido
  • Contenido aprobado
  • Suscripción renovada

Variables de Plantilla​

Usa marcadores de posición en las plantillas de notificación

📊 Tabla de Referencia Rápida - Métodos Comunes​

MétodoQué Hace
getAllSubscriptions()Obtener todas las suscripciones
subscribeByMarker()Suscribirse a un evento específico por marcador
unsubscribeByMarker()Cancelar suscripción de un evento específico por marcador

Nota: Los eventos se configuran en el panel de administración de OneEntry. El SDK es de solo lectura: úsalo para obtener información sobre eventos, no para crear eventos.

❓ Preguntas Comunes (FAQ)​

¿Cómo creo o edito eventos?​

Los eventos se gestionan en el panel de administración de OneEntry:

  1. Inicia sesión en el panel de administración de OneEntry
  2. Ve a la sección de Eventos
  3. Crea o edita eventos
  4. Configura desencadenantes, canales y plantillas
  5. Activa el evento

El SDK es de solo lectura: úsalo para obtener información sobre eventos, no para crear eventos.

¿Cuál es la diferencia entre Notificación Push y Socket.IO?​

Notificación Push - Enviada al dispositivo (funciona incluso cuando la aplicación está cerrada)

  • Aparece en el centro de notificaciones

  • El usuario puede tocar para abrir la aplicación

  • Mejor para: Alertas importantes, recordatorios

  • Socket.IO - Mensaje de websocket en tiempo real (solo cuando la aplicación está abierta)

    • Entrega instantánea a los clientes conectados
    • Actualizaciones en vivo sin necesidad de refrescar
    • Mejor para: Datos en vivo, chat, colaboración

¿Puedo activar manualmente un evento desde mi código?​

El SDK no admite desencadenantes manuales. Los eventos se activan automáticamente según los desencadenantes configurados en OneEntry.

¿Puedo personalizar las plantillas de correo electrónico?​

¡Sí! En el panel de administración de OneEntry:

  • Plantillas de correo HTML
  • Estilo personalizado
  • Soporte multilingüe
  • Prueba antes de activar

¿Qué sucede si un evento no se envía?​

OneEntry maneja reintentos y registros:

  • Los correos fallidos se ponen en cola para reintento
  • Las notificaciones push fallidas se registran
  • Verifica los registros de eventos en el panel de administración
  • Configura opciones de respaldo

¿Puedo usar contenido enriquecido en las notificaciones?​

  • Correo - Soporte completo de HTML (imágenes, enlaces, estilo)
  • Notificación Push - Título + texto del cuerpo + imagen opcional
  • Socket.IO - Cualquier estructura de datos JSON

¿Cuál es la diferencia entre Evento y envío de Formulario?​

  • Eventos - Notificaciones automatizadas activadas por el sistema
  • Formularios - Datos enviados por el usuario que recopilas

Ejemplo:

  • Evento: "Usuario registrado" → Envía automáticamente correo de bienvenida
  • Formulario: El usuario llena el formulario de contacto → Recibes la presentación

💡 Notas Importantes​

📬 Canales de Notificación​

En la Plataforma OneEntry, hay tres formas de interactuar con los usuarios de tu sistema a través del módulo "Events":

  • 📧 Correo - Envía mensajes de correo con contenido HTML enriquecido
  • 📱 Notificación Push - Envía alertas en tiempo real a móviles/navegadores
  • 🔌 Socket.IO - Envía mensajes instantáneos de websocket a clientes conectados

Los Eventos son de Solo Lectura en el SDK​

Recuerda: El SDK es para leer eventos, no para crearlos.

Convención de Nombres de Eventos​

Usa marcadores claros y descriptivos:

✅ Buenas marcas:
- order_confirmed
- product_back_in_stock
- user_registered
- payment_failed
- password_reset_requested

❌ Malas marcas:
- event1
- notification
- email_event
- test

🎓 Mejores Prácticas​

  • Usa marcadores de eventos descriptivos
  • Prueba los eventos antes de activarlos
  • Proporciona valores de respaldo para las variables
  • Monitorea los registros de eventos regularmente
  • Desactiva eventos no utilizados
  • Usa canales apropiados (correo para recibos, push para urgencia)
  • Localiza los mensajes de eventos
  • Maneja eventos faltantes/desactivados de manera adecuada

Más información sobre la interfaz de usuario del módulo https://doc.oneentry.cloud/docs/events/introduction

Definición del módulo Events​


const { Events } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

🔗 Documentación Relacionada​