Pular para o conteúdo principal
Acesse os dados do event stream usando sintaxe Liquid. Envolva o ponto de dados desejado em {{ }} para capturar esses dados no Event Stream. Veja Exemplos.
Limitações de dados de eventos de mensagemDados para mensagens enviadas via nossas Journeys ou API estão disponíveis em nosso sistema apenas por 30 dias. Isso significa que quaisquer eventos de mensagem (como cliques, aberturas, cancelamentos de inscrição, etc.) que acontecem 30+ dias após a mensagem de Journey ou API ser enviada, não estarão disponíveis no event stream. Isso pode aparecer como dados em branco ou ausentes em suas análises.Para contornar essa limitação, você pode correlacionar o message_id desses eventos de clique/abertura/cancelamento de inscrição com o evento enviado original que tem o mesmo message_id. O evento sent original deve ter os dados de mensagem relevantes (título, modelo, etc).

​
Propriedades de event

O objeto event inclui as seguintes propriedades:

​
Kind

Tipo: String O tipo de mensagem (push, email, sms, iam) e evento (por exemplo, received, sent, clicked, failed, unsubscribed, displayed, pagedisplayed, opened, clicked, unsubscribed, reported_as_spam, hardbounced, failed, supressed). Uso: {{ event.kind }}
Tipo de Evento de Mensagem (OneSignal)Nome do evento (no conjunto de dados)Descrição do Evento
Push Enviadomessage.push.sentNotificação push enviada com sucesso para os serviços push (FCM, APNS, etc).
Push Recebidomessage.push.receivedNotificação push recebida pelo destinatário. Não disponível em todas as plataformas. Veja Entrega Confirmada para mais detalhes.
Push Clicadomessage.push.clickedUsuário tocou na notificação push para abrir o aplicativo no dispositivo.
Push Falhoumessage.push.failedPush falhou ao ser enviado. Veja os Relatórios de Mensagens Push para detalhes.
Push Canceladomessage.push.unsubscribedUsuário cancelou inscrição de push assinatura. Veja Quando os status de assinatura push são atualizados?.
Impressão In-Appmessage.iam.displayedMensagem In-App exibida com sucesso no dispositivo.
In-App Clicadomessage.iam.clickedUsuário tocou em um elemento na Mensagem In-App.
Página In-App Exibidamessage.iam.pagedisplayedPágina da Mensagem In-App foi exibida. Útil para rastrear carrosséis.
Email Enviadomessage.email.sentEmail enviado com sucesso.
Email Recebidomessage.email.receivedEmail recebido pelo destinatário.
Email Abertomessage.email.openedEmail foi aberto pelo destinatário. Veja Relatórios de Mensagens de Email para detalhes.
Link de Email Clicadomessage.email.clickedUsuário tocou em um link no email.
Email Canceladomessage.email.unsubscribedUsuário cancelou inscrição de email via link de cancelamento de inscrição.
Email Reportado Como Spammessage.email.reported_as_spamUsuário reportou o email como spam. Gmail requer Google Postmaster Tools para rastrear. Veja Entregabilidade de email para mais detalhes.
Email Rejeitadomessage.email.hardbouncedEmail retornou ao remetente devido a erro permanente. Veja Relatórios de Mensagens de Email para detalhes.
Email Falhoumessage.email.failedEmail não pôde ser entregue. Veja Relatórios de Mensagens de Email para detalhes.
Email Suprimidomessage.email.supressedEmail não pôde ser enviado porque o endereço de email está na Lista de supressão.
SMS Enviadomessage.sms.sentSMS enviado para destinatário
SMS Falhoumessage.sms.failedSMS falhou ao enviar. Veja Relatórios de Mensagens SMS para detalhes.
SMS Entreguemessage.sms.deliveredSMS entregue com sucesso
SMS Não Entreguemessage.sms.undeliveredSMS não pôde ser enviado. Veja Relatórios de Mensagens SMS para detalhes.

​
Event ID

Tipo: UUID Um identificador único gerado pelo OneSignal para cada evento individual no formato UUID v4. Use este ID para rastreamento de entrega idempotente. Se você estiver procurando o identificador de mensagem ou modelo específico, use message.id ou message.template_id. Uso: {{ event.id }}

​
Timestamp

Tipo: Integer O timestamp UNIX do evento. Uso: {{ event.timestamp }}

​
UTC datetime

Tipo: String Um horário legível do evento em UTC (especificamente uma string ISO como “2024-02-21T23:45:15.228Z”). Uso: {{ event.datetime }}

​
App ID

Tipo: UUID O App ID do OneSignal. Uso: {{ event.app_id }}

​
Subscription type

Tipo: String O tipo de assinatura (por exemplo, iOS, Android, Chrome, Email, SMS, etc). Uso: {{ event.subscription_device_type }}

​
Subscription ID

Tipo: UUID O Subscription ID do OneSignal. Uso: {{ event.subscription_id }}

​
OneSignal User ID

Tipo: UUID O User ID criado pelo OneSignal. Uso: {{ event.onesignal_id }}

​
External User ID

Tipo: String Seu User ID definido como o alias de External ID do OneSignal. Pode estar vazio se não definido no OneSignal. Uso: {{ event.external_id }}

​
In-app message page name

Tipo: String O nome da página ou cartão que é exibido para certos eventos de mensagem in-app. Veja Event Streams de mensagens in-app para detalhes. Uso: {{ event.data.page_name }}

​
In-app message page ID

Tipo: String Um identificador único para a página ou cartão que é exibido para certos eventos de mensagem in-app. Veja Event Streams de mensagens in-app para detalhes. Uso: {{ event.data.page_id }}

​
In-app message target name

Tipo: String O nome do botão ou elemento de bloco de imagem clicado. Deve conter uma ação de clique in-app. Veja Event Streams de mensagens in-app para detalhes. Uso: {{ event.data.target_name }}

​
In-app message target ID

Tipo: String Um identificador único para o botão ou elemento de bloco de imagem clicado. Deve conter uma ação de clique in-app. Veja Event Streams de mensagens in-app para detalhes. Uso: {{ event.data.target_id }}

​
Example Input

{
  "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}}"
}

​
Propriedades de Message

O objeto message é projetado para mantê-lo informado das mensagens enviadas ao usuário final. Inclui propriedades como id, template_id e content, que contém o texto real da mensagem.

​
Message ID

Tipo: UUID O ID da mensagem gerado pelo OneSignal. Uso: {{ message.id }}

​
Message Name

Tipo: String O nome da mensagem conforme definido no dashboard ou usando a propriedade name da API. Uso: {{ message.name }}

​
Message Title

Tipo: Object O título da mensagem push ou assunto do email conforme definido no dashboard ou usando as propriedades headings ou email_subject da API. Uso: {{ message.title }}

​
Message Contents

Tipo: Object O conteúdo da mensagem push ou SMS conforme definido no dashboard ou usando a propriedade contents da API (cortado em 50 caracteres). O conteúdo de email (email_body) não é fornecido. Uso: {{ message.contents }}

​
Template ID

Tipo: UUID O ID do modelo para uma mensagem enviada via Journeys ou a propriedade template_id da API. Uso: {{ message.template_id }}

​
Launch URL

Tipo: String A URL de lançamento da mensagem (ao usar apenas uma URL que é agnóstica a web e aplicativo). Veja URLs, Links e Deep Links para detalhes. Uso: {{ message.url }}

​
App-Specific URL

Tipo: String A URL de lançamento da mensagem ao usar uma URL específica para web e aplicativo. Veja URLs, Links e Deep Links para detalhes. Uso: {{ message.app_url }}

​
Web-Specific URL

Tipo: String A URL de lançamento da mensagem ao usar uma URL específica para web e aplicativo. Veja URLs, Links e Deep Links para detalhes. Uso: {{ message.web_url }}

​
Example Message Object

{
  "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"
}

​
Propriedades de User

​
OneSignal ID

Tipo: String O OneSignal ID do usuário. Uso {{ user.onesignal_id }}

​
External ID

Tipo: String O External ID do usuário. Uso: {{ user.external_id }}

​
Tags

Tipo: Object As tags do usuário. Uso:
  • Objeto tags: {{ user.tags }}
  • String de tag específica: {{ user.tags.your_tag }}
  • Se você está tentando obter todas as tags, referencie o objeto tags como {{ user.tags}}.
  • Se você está tentando obter uma tag específica, referencie a tag como uma string assim: "{{ user.tags.your_tag | default: '' }}".

​
Language

Tipo: String O idioma do usuário. Uso: {{ user.language }}

​
Propriedades de Subscription

​
Subscription ID

Tipo: String O ID da assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.id }}

​
App ID

Tipo: String O ID do aplicativo. Uso: {{ user.subscription.app_id }}

​
Subscription Token

Tipo: String O token para a assinatura para a qual a mensagem foi enviada.
  • Se o tipo for Email, o token será um endereço de email.
  • Se o tipo for SMS, o token será um número de telefone no formato E.164.
  • Se o tipo for uma das opções Push, o token será um token push.
Uso: {{ user.subscription.subscription_token }}

​
Session Count

Tipo: Number A contagem de sessões para a assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.session_count }}

​
Language

Tipo: String O idioma definido na assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.language }}

​
Game Version

Tipo: String A versão do jogo definida na assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.game_version }}

​
Last Active

Tipo: Number O último horário ativo definido na assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.last_active }}

​
Play Time

Tipo: Number O tempo de jogo definido na assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.play_time }}

​
Amount Spent

Tipo: Number O valor gasto na assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.amount_spent }}

​
Created At

Tipo: Number O horário de criação da assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.created_at }}

​
Subscribed

Tipo: Boolean Indica se a assinatura para a qual a mensagem foi enviada está atualmente inscrita. Uso: {{ user.subscription.subscribed }}

​
SDK

Tipo: String A versão do SDK definida na assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.sdk }}

​
Device Model

Tipo: String O modelo do dispositivo definido na assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.device_model }}

​
Device OS

Tipo: String O sistema operacional do dispositivo definido na assinatura para a qual a mensagem foi enviada. Uso: {{ user.subscription.device_os }}

​
Tags

Tipo: Object As tags do usuário. Você pode acessar o objeto inteiro ou tags específicas. Uso:
  • Todas as Tags: {{ user.tags }}
  • Tag Específica: {{ user.tags.your_tag }}