Skip to content

Message engagement events

Use the search bar or the checkboxes below to find the events you need to use Currents effectively.

These schema consist of the Braze Events that are directly related to message sending.

Os esquemas de armazenamento se aplicam aos dados de eventos de arquivo simples que enviamos aos parceiros de armazenamento do Data Warehouse (Google Cloud Storage, Amazon S3 e Microsoft Azure Blob Storage). Para esquemas que se aplicam a outros parceiros, consulte nossa lista de parceiros disponíveis e verifique suas respectivas páginas.

Entre em contato com o gerente da sua conta ou abra um ticket de suporte se precisar de acesso a direitos de eventos adicionais. Se não encontrar o que precisa neste artigo, consulte nossa Biblioteca de eventos de comportamento do cliente ou nossos exemplos de dados de amostra Currents .

Explicação da estrutura do evento de engajamento com mensagens e dos valores da plataforma

Estrutura do evento

Esse detalhamento do evento mostra que tipo de informação geralmente é incluído em um evento de engajamento com mensagem. Com uma sólida compreensão de seus componentes, seus desenvolvedores e a equipe de estratégia de business intelligence podem usar os dados de eventos Currents recebidos para criar relatórios e gráficos orientados por dados e tirar proveito de outras métricas de dados valiosas.

Detalhamento de um evento de engajamento com mensagem mostrando um evento de cancelamento de inscrição de e-mail com as propriedades listadas agrupadas por propriedades específicas do usuário, propriedades de rastreamento da campanha ou do Canvas e propriedades específicas do evento

Os eventos de engajamento com mensagens são compostos por propriedades específicas do usuário, propriedades de rastreamento de campanha/canva e propriedades específicas do evento.

Esquema de ID de usuário

Note as convenções de nomenclatura para IDs de usuário.

Esquema do Braze Esquema de Currents Descrição
braze_id "USER_ID" O identificador exclusivo que é atribuído automaticamente pelo Braze.
external_id "EXTERNAL_USER_ID" O identificador exclusivo do perfil de um usuário que é definido pelo cliente.

Valores da plataforma

Certos eventos retornam um valor platform que especifica a plataforma do dispositivo do usuário.
A tabela a seguir detalha os possíveis valores retornados:

Dispositivo do usuário Valor da plataforma
iOS ios
Android android
FireTV kindle
Kindle kindle
Web web
tvOS tvos
Roku roku

Desinstalar eventos

Esse evento ocorre quando um usuário desinstala um app. Use esses dados para rastrear quando os usuários desinstalam um app. Embora esse seja atualmente um evento de engajamento com mensagem, ele será alterado para um evento de comportamento do usuário no futuro.

Eventos de mudança de estado da inscrição global

Esse evento ocorre quando o Braze recebe uma solicitação para atualizar o estado de inscrição global do usuário, mesmo que a solicitação não altere o estado de inscrição atual do usuário.

Detalhes da propriedade

  • state_change_source retornará uma string com o nome completo da fonte. Por exemplo, a importação do CSV de origem retornará a string CSV Import. As fontes disponíveis estão listadas abaixo:
Origem Descrição
SDK Endpoints de SDK
Dashboard Quando o estado da inscrição de um usuário é atualizado na página Perfil do usuário no dashboard
Página de inscrição Quando um usuário cancela a inscrição por meio de um link de cancelamento de inscrição por e-mail que não seja a Central de Preferências
API REST Pontos de extremidade da API REST
Importação de CSV Importação de usuário CSV
Central de Preferências Quando um usuário é atualizado a partir da Central de Preferências
Mensagem recebida Quando um usuário é atualizado por mensagens recebidas de usuários finais por meio de canais, como SMS
Migração Quando um usuário é atualizado por migrações internas ou scripts de manutenção
Mesclagem de usuários Quando um usuário é atualizado pelo processo de mesclagem de usuários
Etapa de atualização do usuário do canva Quando um usuário é atualizado pela etapa de atualização do usuário do Canva
Aceitação automática por registro de token Quando um usuário é atualizado pelo processo de registro de token

Eventos de mudança de estado do grupo de inscrições

Esse evento ocorre quando o estado da inscrição de um usuário em um grupo de inscrições é alterado.

Detalhes da propriedade

  • state_change_source retornará uma string com o nome completo da fonte. Por exemplo, a importação do CSV de origem retornará a string CSV Import. As fontes disponíveis estão listadas abaixo:
Origem Descrição
SDK Endpoints de SDK
Dashboard Quando o estado da inscrição de um usuário é atualizado na página Perfil do usuário no dashboard
Página de inscrição Quando um usuário cancela a inscrição por meio de um link de cancelamento de inscrição por e-mail que não seja a Central de Preferências
API REST Pontos de extremidade da API REST
Importação de CSV Importação de usuário CSV
Central de Preferências Quando um usuário é atualizado a partir da Central de Preferências
Mensagem recebida Quando um usuário é atualizado por mensagens recebidas de usuários finais por meio de canais como SMS
Migração Quando um usuário é atualizado por migrações internas ou scripts de manutenção
Mesclagem de usuários Quando um usuário é atualizado pelo processo de mesclagem de usuários
Etapa de atualização do usuário do canva Quando um usuário é atualizado pela etapa de atualização do usuário do Canva

Eventos de conversão de campanha

Esse evento ocorre quando um usuário realiza uma ação que foi definida como um evento de conversão em uma campanha.

Eventos de inscrição do grupo de controle da campanha

Esse evento ocorre quando um usuário é inscrito em um conjunto de variantes de controle em uma campanha com várias variantes. Esse evento é gerado porque não haverá nenhum evento de envio de canal para esse usuário.

Eventos de conversão do Canva

Esse evento ocorre quando um usuário executa uma ação que foi definida como um evento de conversão no Canva.

Eventos de entrada do Canva

Esse evento ocorre quando um usuário entra no Canva. Esse evento informa em qual variante o usuário entrou.

Eventos do público do Exit Match

Esse evento ocorre quando um usuário sai de um Canva ao corresponder a um público.

Eventos Exit Perform Event

Esse evento ocorre quando um usuário sai de um Canva ao executar um evento.

Experimento Etapa Eventos de conversão

Esse evento ocorre quando um usuário converte para uma etapa do experimento do Canva.

Eventos de entrada dividida de experimentos

Esse evento ocorre quando um usuário entra em uma etapa do experimento do Canva.

Eventos de progressão da etapa do canva

Esse evento ocorre quando um usuário avança em uma etapa do Canva com algum resultado. Note que esse evento não ocorre quando as etapas são inseridas ou encerradas. Atualmente, apenas as etapas divididas (jornadas do público, divisão de decisão, jornadas de ação, experimento) e os resultados avançados geram eventos de progressão de etapas.

Eventos de interrupção do cartão de conteúdo

Esse evento ocorre se uma mensagem do cartão de conteúdo foi abortada com base em abortos do Liquid, etc.

Eventos de clique do cartão de conteúdo

Esse evento ocorre quando um usuário clica em um cartão de conteúdo.

Detalhes da propriedade

  • Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
  • Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.

Cartão de conteúdo Descartar eventos

Esse evento ocorre quando um usuário descarta um cartão de conteúdo.

Detalhes da propriedade

  • Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
  • Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.

Eventos de impressão do cartão de conteúdo

Esse evento ocorre quando um usuário visualiza um cartão de conteúdo.

Detalhes da propriedade

  • Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
  • Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.

Cartão de conteúdo Enviar eventos

Esse evento ocorre quando um cartão de conteúdo é enviado a um usuário.

Detalhes da propriedade

  • message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.

Envio de e-mail Abortar eventos

Esse evento ocorre se uma mensagem de e-mail foi abortada com base em abortos de Liquid, etc.

Eventos de bounce de e-mail

Esse evento ocorre quando um provedor de serviços de Internet retorna um hard bounce. Um hard bounce significa uma falha permanente de entregabilidade.

Detalhes da propriedade

  • O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.

Envio de e-mail Eventos de clique

Esse evento ocorre quando um usuário clica em um e-mail. Vários eventos podem ser gerados para a mesma campanha se um usuário clicar várias vezes ou clicar em diferentes links dentro do e-mail.

Detalhes da propriedade

  • O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.

Eventos de envio de e-mail

Esse evento ocorre quando um provedor de serviços de Internet não entrega imediatamente o e-mail para um endereço de e-mail não hard bounce e o Braze tenta novamente o e-mail por até 72 horas. Os motivos típicos para adiamentos incluem limite de volume de envios de e-mail com base na reputação do provedor de caixa de entrada, problemas temporários de conectividade, caixa de correio do destinatário cheia ou erros de DNS.

Detalhes da propriedade

  • O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.

Eventos de envio de e-mail

Esse evento ocorre quando um e-mail enviado chega com êxito à caixa de entrada do usuário final.

Detalhes da propriedade

  • O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.

Eventos de envio de e-mail para marcar como spam

Esse evento ocorre quando o usuário final pressiona o botão “spam” no e-mail. Observe que isso não representa o fato de o e-mail ter ido para a pasta de spam, pois o Braze não faz esse rastreamento.

Detalhes da propriedade

  • O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.

Envio de e-mail Eventos abertos

Esse evento ocorre quando um usuário abre um e-mail. Vários eventos podem ser gerados para a mesma campanha se um usuário abrir o e-mail várias vezes.

Detalhes da propriedade

  • O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.

Envio de e-mail Enviar eventos

Esse evento ocorre quando uma solicitação de envio de e-mail foi comunicada com êxito entre o Braze e o SendGrid. No entanto, isso não significa que o e-mail foi recebido na caixa de entrada do usuário final.

Detalhes da propriedade

  • O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.
  • message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.

Eventos de envio de e-mail Soft Bounce

Esse evento ocorre quando um prestador de serviço de Internet retorna um soft bounce. Um soft bounce significa que um e-mail não pôde ser entregue devido a uma falha temporária de entregabilidade.

Detalhes da propriedade

  • O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.

Eventos de cancelamento de inscrição de e-mail

Esse evento ocorre quando o usuário final clica em “cancelar inscrição” no e-mail.

Detalhes da propriedade

  • O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.

Feature Flag Experimento Eventos de impressão

Esse evento ocorre sempre que um usuário tem a oportunidade de interagir com o seu recurso ou quando ele poderia ter interagido se o recurso estivesse desativado (no caso de um grupo de controle em um Testes A/B).

As impressões do Feature Flag são registradas apenas uma vez por sessão.

Eventos de clique de mensagem no app

Esse evento ocorre quando um usuário clica em uma mensagem no app.

Detalhes da propriedade

  • Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
  • Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.

Eventos de impressão de mensagens no app

Esse evento ocorre quando um usuário visualiza uma mensagem no app.

Detalhes da propriedade

  • Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
  • Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.

Eventos de interrupção de notificações por push

Esse evento ocorre se uma mensagem de notificação por push foi abortada com base em Liquid aborts, etc.

Eventos de bounce de notificações por push

Esse evento ocorre quando um erro é recebido do serviço de Notificações por Push da Apple ou do Fire Cloud Messaging. Isso significa que a mensagem push sofreu bounce e, portanto, não foi entregue ao dispositivo do usuário.

Detalhes da propriedade

  • Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com seu gerente de sucesso do cliente ou gerente de conta para ativar o flipper de recursos para enviar ad_id.

Notificações por push Eventos de abertura em primeiro plano do iOS

Esse evento não é compatível com nosso Swift SDK e agora está obsoleto em nosso Obj-C SDK .

Detalhes da propriedade

  • Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
  • Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.

Notificações por push Eventos abertos

Esse evento ocorre quando um usuário clica diretamente na notificação por push para abrir o aplicativo. Atualmente, os eventos Push Open referem-se especificamente a “aberturas diretas” em vez de “aberturas totais”. Isso não inclui estatísticas mostradas no nível da campanha de “aberturas por influência”, pois elas não são atribuídas no nível do usuário.

Detalhes da propriedade

  • Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
  • Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.

Eventos de envio de notificações por push

Esse evento ocorre quando a Braze processa uma mensagem push para um usuário, comunicando-a ao Serviço de Notificações por Push da Apple ou ao Fire Cloud Messaging. Isso não significa que o push foi entregue ao dispositivo, apenas que uma mensagem foi enviada.

Detalhes da propriedade

  • Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
  • Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.
  • message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.

Eventos de abortamento de SMS

Esse evento ocorre se uma mensagem SMS foi abortada com base em Liquid aborts, etc.

Eventos de envio da operadora de SMS

Esse evento ocorre quando um SMS é enviado à operadora.

Eventos de entrega de SMS

Esse evento ocorre quando um SMS é entregue com êxito ao telefone celular do usuário.

Eventos de falha na entrega de SMS

Esse evento ocorre quando um SMS apresenta falha na entrega. Use esse evento e os códigos de erro fornecidos para ajudar a solucionar problemas com a entrega de SMS.

Eventos de entrada de SMS recebidos

Esse evento ocorre quando um dos seus usuários envia um SMS para um número de telefone em um dos seus grupos de inscrições do Braze SMS.

Quando o Braze recebe um SMS de entrada, atribuímos essa mensagem de entrada a qualquer usuário que compartilhe esse número de telefone. Como resultado, você poderá receber vários eventos por mensagem recebida se vários usuários na sua instância do Braze compartilharem o mesmo número de telefone. Se for necessária a atribuição de IDs de usuários específicos com base em mensagens anteriores enviadas a esse usuário, é possível usar o evento SMS Delivered para atribuir eventos Inbound Received ao ID do usuário que recebeu mais recentemente uma mensagem do seu número Braze.

Se detectarmos que essa mensagem de entrada é uma resposta a uma campanha de saída ou a um componente do Canvas enviado pelo Braze, também incluiremos os metadados da campanha ou do Canvas no evento. O Braze define uma resposta como uma mensagem recebida dentro de quatro horas após uma mensagem enviada. No entanto, há um cache de um minuto para as informações da campanha de atribuição do último SMS de saída recebido.

Eventos de rejeição de SMS

Esse evento ocorre quando um envio de SMS é rejeitado pela operadora, o que pode ocorrer por vários motivos. Use esse evento e os códigos de erro fornecidos para ajudar a solucionar problemas com a entrega de SMS.

Eventos de envio de SMS

Esse evento ocorre quando um usuário envia um SMS.

Detalhes da propriedade

  • message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.

Esse evento ocorre quando um usuário clica em um link curto de SMS.

Eventos de abortamento de webhook

Esse evento ocorre se uma mensagem de webhook foi abortada com base em Liquid aborts, etc.

Eventos de envio de webhook

Esse evento ocorre quando um webhook foi processado e enviado para o terceiro especificado nesse webhook. Observe que isso não significa que a solicitação foi recebida ou não.

Detalhes da propriedade

  • message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.

Eventos de interrupção do WhatsApp

Esse evento ocorre se uma mensagem do WhatsApp foi abortada com base em abortos de Liquid, etc.

Eventos do WhatsApp Delivery

Esse evento ocorre quando uma mensagem do WhatsApp enviada chega com êxito ao dispositivo do usuário final.

Eventos de falha do WhatsApp

Esse evento ocorre quando o WhatsApp não consegue entregar a mensagem ao usuário. Um hard bounce significa uma falha permanente de entregabilidade.

Eventos recebidos de entrada do WhatsApp

Esse evento ocorre quando um dos seus usuários envia uma mensagem do WhatsApp para um número de telefone em um dos seus grupos de inscrições do Braze WhatsApp.

WhatsApp Ler eventos

Esse evento ocorre quando uma mensagem do WhatsApp é lida pelo usuário final.

Detalhes da propriedade

state_change_source retornará uma string com o nome completo da fonte. Por exemplo, a importação do CSV de origem retornará a string CSV Import. As fontes disponíveis estão listadas abaixo:

Origem Descrição
SDK Endpoints de SDK
Dashboard Quando o estado da inscrição de um usuário é atualizado na página Perfil do usuário no dashboard
Página de inscrição Quando um usuário cancela a inscrição por meio de um link de cancelamento de inscrição por e-mail que não seja a Central de Preferências
API REST Pontos de extremidade da API REST
Importação de CSV Importação de usuário CSV
Central de Preferências Quando um usuário é atualizado a partir da Central de Preferências
Mensagem recebida Quando um usuário é atualizado por mensagens recebidas de usuários finais por meio de canais, como SMS
Migração Quando um usuário é atualizado por migrações internas ou scripts de manutenção
Mesclagem de usuários Quando um usuário é atualizado pelo processo de mesclagem de usuários
Etapa de atualização do usuário do canva Quando um usuário é atualizado pela etapa de atualização do usuário do Canva
Cancelar inscrição de lista Quando um usuário cancela a inscrição por meio do Braze mailto ou do cabeçalho de cancelamento de inscrição da lista de um clique

Eventos de envio do WhatsApp

Esse evento ocorre quando uma solicitação de envio foi comunicada com êxito entre o Braze e o WhatsApp. No entanto, isso não significa que a mensagem foi recebida pelo usuário final.

QUÃO ÚTIL FOI ESTA PÁGINA?
New Stuff!