{{ }} para incluirlo en el cuerpo de tu Event Stream. Ver Ejemplos.
Propiedades de event
Cada evento incluye los campos principales a continuación. Los campos específicos de canal bajo event.data.* se incluyen solo cuando corresponde — ver Campos específicos de canal.
string
El tipo de evento, combinando canal y acción (ej.:
message.push.clicked, message.email.bounced). Ver la lista completa de valores en la referencia de event kind a continuación. Liquid: {{ event.kind }}UUID
Un identificador único generado por OneSignal para cada evento individual en formato UUID v4. Usa este ID para rastreo de entrega idempotente. Para el identificador de mensaje o plantilla, usa
message.id o message.template_id. Liquid: {{ event.id }}integer
Marca de tiempo UNIX del evento. Liquid:
{{ event.timestamp }}string
Hora legible del evento en UTC como cadena ISO 8601 (ej.: “2024-02-21T23:45:15.228Z”). Liquid:
{{ event.datetime }}string
El tipo de suscripción (ej.:
iOS, Android, Chrome, Email, SMS). Liquid: {{ event.subscription_device_type }}UUID
El Subscription ID de OneSignal. Liquid:
{{ event.subscription_id }}string
Tu User ID establecido como el alias External ID de OneSignal. Puede estar vacío si no se estableció. Liquid:
{{ event.external_id }}Campos específicos de canal
Estos camposevent.data.* solo están presentes para ciertos tipos de evento.
Eventos de mensajes in-app
Incluidos con eventosmessage.iam.*. Ver Event Streams de mensajes in-app para detalles.
string
El nombre de la página o tarjeta del mensaje in-app que se mostró. Liquid:
{{ event.data.page_name }}string
Identificador único para la página o tarjeta del mensaje in-app que se mostró. Liquid:
{{ event.data.page_id }}string
El nombre del botón o elemento de bloque de imagen en el que se hizo clic. El elemento debe contener una acción de clic in-app. Liquid:
{{ event.data.target_name }}string
Identificador único para el botón o elemento de bloque de imagen en el que se hizo clic. Liquid:
{{ event.data.target_id }}Eventos de Live Activity
Incluidos con eventosmessage.live_activity.*.
string
Identificador único para una Live Activity específica (ej.: “Knicks vs Cavs - Oct 22 7PM”). Liquid:
{{ event.data.live_activity_id }}string
Etiqueta de agrupación para categorías de Live Activity (ej.: “Knicks_games”). Liquid:
{{ event.data.live_activity_type }}Eventos fallidos
Incluidos con eventosmessage.push.failed y message.email.failed.
string
El motivo por el que el mensaje no se pudo enviar. Ver Informes de mensajes Push o Informes de mensajes de Email para razones comunes. Liquid:
{{ event.data.failure_reason }}Referencia de event kind
Para definiciones detalladas de cada métrica, ver el Glosario de métricas.Ejemplo de objeto de evento
Copia este template Liquid en el cuerpo de tu Event Stream para capturar todos los campos de evento:JSON
Ejemplo de salida renderizada
Ejemplo de salida renderizada
Cómo se ve un evento de clic en push después del renderizado Liquid:Los campos específicos de canal como
JSON
event.data.page_name están vacíos para los tipos de evento que no los incluyen.Propiedades de message
El objeto message describe el mensaje enviado al usuario final, incluyendo su ID, plantilla, contenido y URLs.
UUID
El ID de mensaje generado por OneSignal. Liquid:
{{ message.id }}string
El nombre del mensaje tal como se estableció en el dashboard o usando la propiedad
name de la API. Liquid: {{ message.name }}object
El título del mensaje push o asunto de email. Para push, devuelve un objeto localizado como
{'en':'Your title'}. Para email, devuelve la línea de asunto como cadena simple. Establecido via dashboard o propiedades headings / email_subject de la API. Liquid: {{ message.title }}object
El contenido del mensaje push o SMS (recortado a 50 caracteres). El contenido de email (
email_body) no se proporciona. Establecido via dashboard o propiedad contents de la API. Liquid: {{ message.contents }}UUID
El ID de plantilla para un mensaje enviado mediante Journeys o la propiedad
template_id de la API. Liquid: {{ message.template_id }}string
La URL de lanzamiento del mensaje cuando se usa una sola URL agnóstica para web y app. Ver URLs, Links y Deep Links. Liquid:
{{ message.url }}string
La URL de lanzamiento específica de la app cuando se usan URLs separadas de web y app. Ver URLs, Links y Deep Links. Liquid:
{{ message.app_url }}string
La URL de lanzamiento específica de la web cuando se usan URLs separadas de web y app. Ver URLs, Links y Deep Links. Liquid:
{{ message.web_url }}string
El tipo de acción de Live Activity:
start, update o end. Solo presente para eventos message.live_activity.*. Liquid: {{ message.live_activity_event_kind }}Ejemplo de objeto de mensaje
Copia este template Liquid en el cuerpo de tu Event Stream para capturar todos los campos de mensaje:JSON
Ejemplo de salida renderizada
Ejemplo de salida renderizada
Una notificación push:Un mensaje de email —
JSON
message.title es la línea de asunto como cadena simple, y message.contents está vacío porque el contenido del cuerpo del email no se incluye en los datos del Event Stream:JSON
Propiedades de user
El objeto user contiene datos a nivel de perfil del usuario que recibió el mensaje.
string
El OneSignal ID del usuario. Liquid:
{{ user.onesignal_id }}string
El External ID del usuario. Liquid:
{{ user.external_id }}object
Las etiquetas del usuario. Accede al objeto completo con
{{ user.tags }} o a una etiqueta específica con {{ user.tags.your_tag }}. Usa un valor predeterminado para manejar etiquetas faltantes: {{ user.tags.your_tag | default: '' }}.string
El código de idioma del usuario. Liquid:
{{ user.language }}Propiedades de subscription
Estas propiedades describen la suscripción que recibió el mensaje.
string
El OneSignal ID de la suscripción. Liquid:
{{ user.subscription.id }}string
El OneSignal App ID. Liquid:
{{ user.subscription.app_id }}string
El token específico de plataforma de la suscripción. Para Email, es la dirección de email. Para SMS, un número de teléfono en formato E.164. Para Push, el token push. Liquid:
{{ user.subscription.subscription_token }}number
Total de sesiones registradas para esta suscripción. Liquid:
{{ user.subscription.session_count }}string
El código de idioma establecido en la suscripción. Liquid:
{{ user.subscription.language }}string
La versión de app o juego reportada por la suscripción. Liquid:
{{ user.subscription.game_version }}number
Timestamp UNIX de la sesión más reciente de la suscripción. Liquid:
{{ user.subscription.last_active }}number
Tiempo total de juego registrado para esta suscripción, en segundos. Liquid:
{{ user.subscription.play_time }}number
Monto total de compras in-app registrado para esta suscripción. Liquid:
{{ user.subscription.amount_spent }}number
Timestamp UNIX de cuando se creó la suscripción. Liquid:
{{ user.subscription.created_at }}boolean
Si la suscripción está actualmente activa. Liquid:
{{ user.subscription.subscribed }}string
La versión del OneSignal SDK en el dispositivo de la suscripción. Liquid:
{{ user.subscription.sdk }}string
El modelo de hardware del dispositivo (ej.: “iPhone14,2”, “Pixel 7”). Liquid:
{{ user.subscription.device_model }}string
El sistema operativo y versión del dispositivo (ej.: “iOS 17.2”, “Android 14”). Liquid:
{{ user.subscription.device_os }}Páginas relacionadas
Event Streams
Configura Event Streams, incluyendo setup, templates de cuerpo y depuración.
Uso de sintaxis Liquid
Referencia de sintaxis Liquid para personalizar cuerpos de Event Stream.
Event Streams de mensajes in-app
Detalles sobre datos de eventos de mensajes in-app y rastreo de carruseles.
Glosario de métricas
Definiciones de todas las métricas de eventos de mensaje entre canales.
Preguntas frecuentes
¿Por qué faltan o están en blanco algunos datos de evento?
Los datos de mensajes para Journeys y envíos vía API se retienen durante 30 días. Si un usuario interactúa con un mensaje (clic, apertura, cancelación de suscripción) más de 30 días después de enviarse, las propiedades de mensaje asociadas pueden estar en blanco. Para solucionar esto, correlaciona elmessage.id del evento de interacción con el evento sent original, que contiene los datos completos del mensaje.
¿Cuál es la diferencia entre event.id y message.id?
event.id es un identificador único para el evento individual (ej.: un clic específico). message.id es el identificador del mensaje que fue enviado — múltiples eventos pueden compartir el mismo message.id (por ejemplo, un evento sent y un evento clicked para la misma notificación push).
¿Cuál es el formato de message.title para push vs email?
Para notificaciones push, message.title devuelve un objeto localizado como {'en':'Your title'}. Para email, devuelve la línea de asunto como cadena simple. El formato depende del canal.
¿Los Eventos Personalizados están incluidos en Event Streams?
No. Event Streams contiene eventos de mensaje (enviado, clicado, abierto, rebotado, etc.) — no Eventos Personalizados. Los Eventos Personalizados son acciones del usuario que envías a OneSignal. Event Streams exporta datos de entrega y participación de mensajes desde OneSignal.¿Cómo hago referencia a una etiqueta específica en el cuerpo de mi Event Stream?
Usa{{ user.tags.your_tag_key }} con la clave de etiqueta exacta. Para evitar errores cuando una etiqueta no está definida, agrega un valor predeterminado: {{ user.tags.your_tag_key | default: '' }}. Ver Uso de sintaxis Liquid para más detalles.