Saltar al contenido principal

Introducción

Suscríbete a notificaciones y actualizaciones relacionadas con productos.

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

🎯 ¿Qué hace este módulo?​

El módulo Events te permite suscribir usuarios a notificaciones de productos - como un correo electrónico cuando un producto está de nuevo en stock, o una alerta cuando el precio baja. Configuras los eventos en el panel de administración de OneEntry; el SDK gestiona quién está suscrito a qué.

Piénsalo como un sistema de suscripción de productos - los usuarios se suscriben a productos específicos (o formularios) y reciben notificaciones cuando algo cambia.

🚀 Inicio Rápido​

Inicializa el módulo desde defineOneEntry:


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

Lista los eventos disponibles (públicos — no se necesita autorización):

// Fetch all events configured in the admin panel.
const events = await Events.getAllEvents();

events.forEach((event) => {
  console.log(event);
});

Para suscribir a un usuario a un evento de producto primero debes estar autorizado, luego llama a subscribeByMarker(marker, productId, langCode?):

// Requires an authorized user (see AuthProvider).
const ok = await Events.subscribeByMarker("product_price_change", 12345, "en_US");
console.log(ok); // true on success

✨ Conceptos Clave​

¿Qué es un Evento de Producto?​

Un evento de producto es una notificación desencadenada por cambios en un producto:

  • Desencadenante - lo que sucede con el producto (por ejemplo, "de nuevo en stock", "bajada de precio")
  • Notificación - lo que reciben los suscriptores (correo electrónico o push)
  • Suscriptores - usuarios que optaron por recibir actualizaciones de este producto
  • Plantilla - el contenido del mensaje de notificación (configurado en el panel de administración)

El módulo también soporta eventos de formulario: suscribirse / darse de baja de notificaciones vinculadas a una presentación de formulario con subscribeToForm / unsubscribeFromForm.

Canales de Notificación​

CanalDescripciónMejor Para
Correo ElectrónicoEnviar mensajes por correoAlertas de reposición, bajadas de precio, boletines
Notificación PushAlertas móviles/navegadorAlertas urgentes, ventas flash

📋 Lo Que Necesitas Saber​

Los eventos se configuran en el panel de administración​

Los desencadenantes, canales y plantillas se configuran en el panel de administración de OneEntry. El SDK no crea eventos ni los activa manualmente — los eventos se activan automáticamente cuando cambian los datos del producto. El SDK es para listar eventos y gestionar suscripciones.

Autorización​

getAllEvents() es público. Cada método de suscripción (getAllSubscriptions, subscribeByMarker, unsubscribeByMarker, subscribeToForm, unsubscribeFromForm, getFormSubscriptions) requiere un usuario autorizado — consulta AuthProvider.

Variables de Plantilla​

Utiliza marcadores de posición en las plantillas de notificación para incluir detalles del producto como nombre, precio y disponibilidad. Las plantillas se editan en el panel de administración.

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

MétodoQué Hace
getAllEvents()Obtener todos los eventos disponibles
getAllSubscriptions() 🔐Obtener todas las suscripciones de productos
subscribeByMarker() 🔐Suscribirse a un evento de producto por marcador
unsubscribeByMarker() 🔐Darse de baja de un evento de producto por marcador
subscribeToForm() 🔐Suscribirse a un evento de formulario por marcador
unsubscribeFromForm() 🔐Darse de baja de un evento de formulario por marcador
getFormSubscriptions() 🔐Obtener todas las suscripciones de formularios

🔐 los métodos requieren autorización del usuario — consulta AuthProvider. getAllEvents() es público.

❓ Preguntas Comunes (FAQ)​

¿Cómo creo o edito eventos de producto?​

Los eventos se crean y configuran en el panel de administración de OneEntry (sección de Eventos) — configura los desencadenantes, canales y plantillas allí, luego activa el evento. El SDK solo lista eventos y gestiona suscripciones.

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

No. El SDK no soporta desencadenantes manuales — los eventos se activan automáticamente según los desencadenantes configurados en OneEntry cuando cambian los datos del producto.

¿Por qué falla la suscripción con un error de autorización?​

Los métodos de suscripción requieren un usuario autorizado. Autoriza primero a través del módulo AuthProvider, luego llama a subscribeByMarker / subscribeToForm. getAllEvents() funciona sin autorización.

🎓 Mejores Prácticas​

  • Autoriza al usuario antes de llamar a cualquier método de suscripción.
  • Utiliza marcadores de evento descriptivos (por ejemplo, product_back_in_stock, product_price_drop).
  • Siempre ofrece un camino fácil para darse de baja (unsubscribeByMarker / unsubscribeFromForm).
  • Maneja los errores de suscripción de manera adecuada y verifica la forma de retorno IError.

🔗 Documentación Relacionada​