Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.nippy.la/llms.txt

Use this file to discover all available pages before exploring further.

track() registra un evento de negocio y evalúa si alguna regla de campaña debe activar una mecánica.

​
Uso

const result = await nippy.track({
  userId: 'user-123',
  campaignId: 'camp-abc',
  eventType: 'card.purchase.completed',
  properties: { value: 500 },
  occurredAt: new Date().toISOString()
})

​
Parámetros

​
userId
string
requerido
Identificador del usuario en tu sistema. Ejemplo: user-123.
​
campaignId
string
requerido
ID de la campaña que debe evaluar el evento. Ejemplo: camp-abc.
​
eventType
string
requerido
Tipo de evento configurado en la regla. Ejemplo: card.purchase.completed.
​
properties
object
predeterminado:"{}"
Datos del evento que se evalúan en condiciones de reglas. Ejemplo: { "value": 500 }.
​
occurredAt
string
predeterminado:"hora de recepción"
Timestamp ISO 8601 de cuándo ocurrió el evento. Ejemplo: 2026-05-01T12:00:00.000Z.

​
Respuesta

​
triggered
array
Lista de mecánicas activadas por el evento. Si está vacía, ninguna regla aplicó.
​
triggered[].spinId
string
ID del spin disparado.
​
triggered[].campaignId
string
ID de la campaña que activó el spin.
​
triggered[].ruleId
string
ID de la regla que activó el spin.
track() no retorna el resultado del spin. El resultado llega por webhook spin.completed.