Saltar al contenido principal
Accede a los datos de event stream usando sintaxis Liquid. Envuelve el punto de datos deseado en {{ }} para capturar esos datos en el Event Stream. Ver Ejemplos.
Limitaciones de datos de eventos de mensajesLos datos de mensajes enviados mediante nuestros Journeys o API solo están disponibles en nuestro sistema durante 30 días. Esto significa que cualquier evento de mensaje (como clics, aperturas, cancelaciones de suscripción, etc.) que ocurra 30+ días después de que se envió el mensaje de Journey o API, no estará disponible en el event stream. Esto puede aparecer como datos en blanco o faltantes en tus análisis.Para solucionar esta limitación, puedes correlacionar el message_id de estos eventos de clic/apertura/cancelación de suscripción con el evento de envío original que tiene el mismo message_id. El evento sent original debería tener los datos de mensaje relevantes (título, plantilla, etc.).

​
Propiedades de event

El objeto event incluye las siguientes propiedades:

​
Kind

Tipo: String El tipo de mensaje (push, email, sms, iam) y evento (por ejemplo, received, sent, clicked, failed, unsubscribed, displayed, pagedisplayed, opened, clicked, unsubscribed, reported_as_spam, hardbounced, failed, supressed). Uso: {{ event.kind }}
Tipo de evento de mensaje (OneSignal)Nombre del evento (en conjunto de datos)Descripción del evento
Push enviadomessage.push.sentNotificación push enviada exitosamente a los servicios push (FCM, APNS, etc.).
Push recibidomessage.push.receivedNotificación push recibida por el destinatario. No disponible en todas las plataformas. Ver Entrega confirmada para más detalles.
Push con clicmessage.push.clickedEl usuario tocó la notificación push para abrir la aplicación en el dispositivo.
Push fallidomessage.push.failedEl push falló al enviarse. Ver los Informes de mensajes Push para detalles.
Push canceladomessage.push.unsubscribedEl usuario canceló la suscripción push. Ver ¿Cuándo se actualizan los estados de suscripción push?.
Impresión In-Appmessage.iam.displayedMensaje In-App mostrado exitosamente en el dispositivo.
In-App con clicmessage.iam.clickedEl usuario tocó un elemento en el mensaje In-App.
Página In-App mostradamessage.iam.pagedisplayedSe mostró la página del mensaje In-App. Útil para rastrear carruseles.
Email enviadomessage.email.sentEmail enviado exitosamente.
Email recibidomessage.email.receivedEmail recibido por el destinatario.
Email abiertomessage.email.openedEl email fue abierto por el destinatario. Ver Informes de mensajes de Email para detalles.
Enlace de Email con clicmessage.email.clickedEl usuario tocó un enlace en el email.
Email canceladomessage.email.unsubscribedEl usuario canceló la suscripción del email mediante el enlace de cancelación.
Email reportado como spammessage.email.reported_as_spamEl usuario reportó el email como spam. Gmail requiere Google Postmaster Tools para rastrear. Ver Entregabilidad de email para más detalles.
Email rebotadomessage.email.hardbouncedEmail devuelto al remitente debido a error permanente. Ver Informes de mensajes de Email para detalles.
Email fallidomessage.email.failedEl email no pudo ser entregado. Ver Informes de mensajes de Email para detalles.
Email suprimidomessage.email.supressedEl email no pudo ser enviado porque la dirección de email está en la lista de supresión.
SMS enviadomessage.sms.sentSMS enviado al destinatario
SMS fallidomessage.sms.failedEl SMS falló al enviarse. Ver Informes de mensajes SMS para detalles.
SMS entregadomessage.sms.deliveredSMS entregado exitosamente
SMS no entregadomessage.sms.undeliveredEl SMS no pudo ser enviado. Ver Informes de mensajes SMS para detalles.

​
Event ID

Tipo: UUID Un identificador único generado por OneSignal para cada evento individual en formato UUID v4. Usa este ID para rastreo de entrega idempotente. Si estás buscando el identificador específico del mensaje o plantilla, usa message.id o message.template_id. Uso: {{ event.id }}

​
Timestamp

Tipo: Integer La marca de tiempo UNIX del evento. Uso: {{ event.timestamp }}

​
UTC datetime

Tipo: String Una hora legible del evento en UTC (específicamente una cadena ISO como “2024-02-21T23:45:15.228Z”). Uso: {{ event.datetime }}

​
App ID

Tipo: UUID El App ID de OneSignal. Uso: {{ event.app_id }}

​
Subscription type

Tipo: String El tipo de suscripción (por ejemplo, iOS, Android, Chrome, Email, SMS, etc). Uso: {{ event.subscription_device_type }}

​
Subscription ID

Tipo: UUID El Subscription ID de OneSignal. Uso: {{ event.subscription_id }}

​
OneSignal User ID

Tipo: UUID El User ID creado por OneSignal. Uso: {{ event.onesignal_id }}

​
External User ID

Tipo: String Tu User ID establecido como el alias External ID de OneSignal. Puede estar vacío si no se estableció en OneSignal. Uso: {{ event.external_id }}

​
In-app message page name

Tipo: String El nombre de la página o tarjeta que se muestra para ciertos eventos de mensajes in-app. Ver Event Streams de mensajes In-app para más detalles. Uso: {{ event.data.page_name }}

​
In-app message page ID

Tipo: String Un identificador único para la página o tarjeta que se muestra para ciertos eventos de mensajes in-app. Ver Event Streams de mensajes In-app para más detalles. Uso: {{ event.data.page_id }}

​
In-app message target name

Tipo: String El nombre del botón o elemento de bloque de imagen en el que se hizo clic. Debe contener una acción de clic in-app. Ver Event Streams de mensajes In-app para más detalles. Uso: {{ event.data.target_name }}

​
In-app message target ID

Tipo: String Un identificador único para el botón o elemento de bloque de imagen en el que se hizo clic. Debe contener una acción de clic in-app. Ver Event Streams de mensajes In-app para más detalles. Uso: {{ event.data.target_id }}

​
Ejemplo de entrada

{
  "event.kind": "{{ event.kind }}",
  "event.id": "{{ event.id }}",
  "event.timestamp": "{{ event.timestamp }}",
  "event.datetime": "{{ event.datetime }}",
  "event.app_id": "{{ event.app_id }}",
  "event.subscription_device_type": "{{ event.subscription_device_type }}",
  "event.subscription_id": "{{ event.subscription_id }}",
  "event.onesignal_id": "{{ event.onesignal_id }}",
  "event.external_id": "{{ event.external_id }}",
  "event.data.page_name": "{{ event.data.page_name}}",
  "event.data.page_id": "{{ event.data.page_id}}",
  "event.data.target_name": "{{ event.data.target_name}}",
  "event.data.target_id": "{{ event.data.target_id}}"
}

​
Propiedades de mensaje

El objeto message está diseñado para mantenerte informado de los mensajes enviados al usuario final. Incluye propiedades como id, template_id y content, que contiene el texto real del mensaje.

​
Message ID

Tipo: UUID El ID de mensaje generado por OneSignal. Uso: {{ message.id }}

​
Message Name

Tipo: String El nombre del mensaje tal como se estableció en el dashboard o usando la propiedad name de la API. Uso: {{ message.name }}

​
Message Title

Tipo: Object El título del mensaje push o asunto de email tal como se estableció en el dashboard o usando las propiedades headings o email_subject de la API. Uso: {{ message.title }}

​
Message Contents

Tipo: Object El contenido del mensaje push o SMS tal como se estableció en el dashboard o usando la propiedad contents de la API (recortado a 50 caracteres). El contenido de email (email_body) no se proporciona. Uso: {{ message.contents }}

​
Template ID

Tipo: UUID El ID de plantilla para un mensaje enviado mediante Journeys o la propiedad template_id de la API. Uso: {{ message.template_id }}

​
Launch URL

Tipo: String La URL de lanzamiento del mensaje (cuando se usa solo una URL que es agnóstica para web y app). Ver URLs, Links y Deep Links para más detalles. Uso: {{ message.url }}

​
App-Specific URL

Tipo: String La URL de lanzamiento del mensaje cuando se usa tanto una URL específica para web como para app. Ver URLs, Links y Deep Links para más detalles. Uso: {{ message.app_url }}

​
Web-Specific URL

Tipo: String La URL de lanzamiento del mensaje cuando se usa tanto una URL específica para web como para app. Ver URLs, Links y Deep Links para más detalles. Uso: {{ message.web_url }}

​
Ejemplo de objeto de mensaje

{
  "message.id": "f3c9cd09-10d7-4f59-b9bc-66e16607f1d5",
  "message.name": "the-name-you-set",
  "message.title": "Claim 50% Off Today", // email subject example
  "message.title": "{'en':'the message title/headings'}", // push title example
  "message.contents": "{'en':'the message content'}",
  "message.template_id": "the-template-uuid-if-set",
  "message.url": "the-message-url",
  "message.app_url": "the-message-app-url",
  "message.web_url": "the-message-web-url"
}

​
Propiedades de usuario

​
OneSignal ID

Tipo: String El OneSignal ID del usuario. Uso {{ user.onesignal_id }}

​
External ID

Tipo: String El External ID del usuario. Uso: {{ user.external_id }}

​
Tags

Tipo: Object Las etiquetas del usuario. Uso:
  • Objeto de etiquetas: {{ user.tags }}
  • Cadena de etiqueta específica: {{ user.tags.your_tag }}
  • Si estás intentando obtener todas las etiquetas, referencia el objeto de etiquetas como {{ user.tags}}.
  • Si estás intentando obtener una etiqueta específica, referencia la etiqueta como una cadena de texto como: "{{ user.tags.your_tag | default: '' }}".

​
Language

Tipo: String El idioma del usuario. Uso: {{ user.language }}

​
Propiedades de suscripción

​
Subscription ID

Tipo: String El ID de la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.id }}

​
App ID

Tipo: String El ID de la aplicación. Uso: {{ user.subscription.app_id }}

​
Subscription Token

Tipo: String El token de la suscripción a la que se envió el mensaje.
  • Si el tipo es Email, el token será una dirección de email.
  • Si el tipo es SMS, el token será un número de teléfono en formato E.164.
  • Si el tipo es una de las opciones de Push, el token será un token push.
Uso: {{ user.subscription.subscription_token }}

​
Session Count

Tipo: Number El conteo de sesiones de la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.session_count }}

​
Language

Tipo: String El idioma establecido en la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.language }}

​
Game Version

Tipo: String La versión del juego establecida en la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.game_version }}

​
Last Active

Tipo: Number La última hora activa establecida en la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.last_active }}

​
Play Time

Tipo: Number El tiempo de juego establecido en la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.play_time }}

​
Amount Spent

Tipo: Number La cantidad gastada en la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.amount_spent }}

​
Created At

Tipo: Number El momento de creación de la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.created_at }}

​
Subscribed

Tipo: Boolean Indica si la suscripción a la que se envió el mensaje está actualmente suscrita. Uso: {{ user.subscription.subscribed }}

​
SDK

Tipo: String La versión del SDK establecida en la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.sdk }}

​
Device Model

Tipo: String El modelo de dispositivo establecido en la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.device_model }}

​
Device OS

Tipo: String El sistema operativo del dispositivo establecido en la suscripción a la que se envió el mensaje. Uso: {{ user.subscription.device_os }}

​
Tags

Tipo: Object Las etiquetas del usuario. Puedes acceder al objeto completo o a etiquetas específicas. Uso:
  • Todas las etiquetas: {{ user.tags }}
  • Etiqueta específica: {{ user.tags.your_tag }}