Event Streams

​

Casos de uso comuns

1. Mapeamento e personalização de jornada do cliente: transmita eventos para um CRM ou Plataforma de Dados do Cliente (CDP) para construir perfis abrangentes de clientes e adaptar campanhas em vários pontos de contato.
2. Análise e relatórios: envie eventos de mensagem (por exemplo, envios, aberturas, cliques) para um data warehouse para analisar padrões de engajamento ou tendências de longo prazo entre canais.
3. Relatórios de conformidade e regulatórios: transmita todos os dados de mensagens enviadas para um data warehouse para fins de auditoria e conformidade.
4. IA e modelos preditivos: envie dados de eventos de mensagem para IA interna ou modelos preditivos para criar coortes abrangentes de clientes e entender riscos de churn — como cancelamentos de inscrição de email ou dispensas de mensagens, que podem indicar potencial churn.
5. Automação de marketing: envie eventos de engajamento (como aberturas ou cliques de mensagem) para outras ferramentas para acionar automaticamente as próximas etapas na jornada do usuário ou atualizar perfis de clientes e atividades recentes.
6. Fragmentação de dados: dados valiosos de clientes geralmente residem em ferramentas separadas (como plataformas de engajamento de clientes, CRMs, ferramentas de análise e data warehouses). A transmissão de eventos ajuda a centralizar esses dados, aumentando a visibilidade em dados de primeira parte valiosos e permitindo resultados de receita mais rápidos.
7. Comunicação lenta entre sistemas: ao enviar eventos de engajamento ao vivo para outros sistemas, você pode acionar ações imediatamente após a ocorrência de um evento, em vez de esperar horas ou dias por atualizações em lote. Isso elimina a dependência de importações manuais ou sincronizações de dados.
8. Inchaço de gastos e dívida técnica: em vez de gerenciar várias ferramentas intermediárias, você pode conectar diretamente o OneSignal ao seu data warehouse. Isso reduz a sobrecarga custosa de gerenciar múltiplas integrações ou pipelines de dados personalizados, diminui a dívida técnica e preserva recursos técnicos valiosos para produto e marketing.

​

Como fazer parceria com sua equipe técnica

1. Explicar os benefícios: compartilhe sua estratégia para usar esses dados e como eles podem melhorar campanhas de marketing, personalizar experiências do usuário, consolidar dados e reduzir dívida técnica.
2. Definir o escopo: identifique para onde você deseja que os dados sejam enviados, quais eventos deseja rastrear e o volume de dados estimado. Isso ajudará na configuração adequada do endpoint.
3. Fornecer documentação técnica: compartilhe a documentação técnica e instruções de configuração do OneSignal. Sua equipe de desenvolvimento precisará configurar os endpoints destinatários e o event stream no OneSignal, garantindo que os dados sejam roteados corretamente.
4. Discutir volume e gerenciamento de dados: confirme que seus sistemas podem lidar com fluxos de dados em tempo real. É recomendável que o manipulador de API registre eventos sem processamento online adicional para manter tempos de resposta baixos.
5. Testar e solucionar problemas: realize testes para garantir que tudo esteja funcionando perfeitamente antes de entrar em produção.

​

Configuração

​

Requisitos

• Uma URL ou endereço IP válido apontando para seu servidor HTTP(S)
• URLs e endereços IP devem ser publicamente roteáveis
• Domínios devem incluir um domínio de nível superior reconhecido (por exemplo, “.com”, “.net”)

​

Seleção de Evento

Trigger Webhook

Event Selection

​

Filtros de event stream

Filtering events by template

Copying the Template ID of a template

• Template – https://dashboard.onesignal.com/apps/{APP_ID}/templates/{TEMPLATE_ID}
• Push – https://dashboard.onesignal.com/apps/{APP_ID}/notifications/{MESSAGE_ID}
• Email – https://dashboard.onesignal.com/apps/{APP_ID}/email/{MESSAGE_ID}
• SMS – https://dashboard.onesignal.com/apps/{APP_ID}/sms/{MESSAGE_ID}

​

Configurar o Event Stream

​

Cabeçalhos de Autenticação

• Cabeçalho de Autorização: Adicione um cabeçalho Authorization, onde YOUR_TOKEN é fornecido pelo seu sistema ou terceiros como:
  • Basic {{YOUR_TOKEN}}
  • Bearer {{YOUR_TOKEN}}
  • ApiKey {{YOUR_API_KEY}}
• Cabeçalhos Personalizados: Você também pode adicionar cabeçalhos personalizados como:
  • X-API-Key: {{YOUR_API_KEY}}

​

Testando Sua Configuração

Configure Webhook

​

Cabeçalhos não permitidos

• content-length
• referer
• metadata-flavor
• x-google-metadata-request
• host
• x-onesignal*

​

Corpo

Event Stream Body Options

cURL Preview of Event Stream

​

Personalização

​

Exemplo de corpo

{
  "Event Data": {
    "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 }}"
  },
  "Message Data": {
    "message.id": "{{ message.id }}",
    "message.name": "{{ message.name }}",
    "message.title": "{{ message.title.en }}",
    "message.contents": "{{ message.contents.en }}",
    "template_id": "{{ message.template_id }}",
    "message.template_id": "{{ message.template_id }}",
    "message.url": "{{ message.url }}",
    "message.app_url": "{{ message.app_url }}",
    "message.web_url": "{{ message.web_url }}"
  }
}

Custom Body

​

Usando Sintaxe Liquid em JSON

• Strings → Devem ser envolvidas em aspas.
• Números → Não envolver em aspas.
• Objetos → Não devem ser envolvidos em aspas.

​

Strings

// Envolva valores de string em aspas
{
  "user_id": "{{ user.onesignal_id }}"
}

{
  "user_id": {{ user.onesignal_id }}
}

​

Números e Booleanos

// Não envolva números ou booleanos em aspas
{
  "user_score": {{ user.tags.score }}
}

{
  "user_score": "{{ user.tags.score }}"
}

​

Objetos

// Não envolva objetos em aspas.
{
  "user_data": {{ user.tags }}
}

{
  "user_data": "{{ user.tags }}"
}

1. Use Verificações Diretas de Idioma: Sempre verifique user.language diretamente em condicionais, não em variáveis como userLang, para melhor compatibilidade.
2. Comece Simples: Comece com frases básicas e, em seguida, adicione complexidade gradualmente.
3. Evite Aninhamento Excessivo: Mantenha as condicionais planas para evitar problemas de análise.
4. Teste a Pontuação Básica Primeiro: Comece com frases e pontuação simples antes de usar caracteres especiais.
5. Use Valores Padrão: Garanta um idioma padrão (por exemplo, inglês) em caso de traduções ausentes.
6. Atenha-se às Chaves Padrão: Use chaves padrão do OneSignal como content/title/en para confiabilidade.

​

Resultados e Depuração

Event Stream Logs and Metrics

​

Tentativas / Desabilitação

​

Dicas para Sucesso

• Normalmente, você desejará que os event streams se conectem aos seus próprios servidores, não a serviços de terceiros.
  • Embora não haja nada de errado em se conectar diretamente a um terceiro, o seguinte pode ser mais difícil de gerenciar: Será mais desafiador configurar/depurar
• O volume de solicitações não será gerenciado no OneSignal.
  • Os eventos de event stream serão enviados tão rápido quanto os usuários atingirem as etapas em sua jornada e isso pode sobrecarregar outros serviços, atingir limites de taxa ou aumentar SUA conta inesperadamente. Isso é especialmente comum ao tentar usar outro canal de mensagens para algo como SMS. A flexibilidade dos event streams significa que o OneSignal não sabe o que você está tentando realizar com eles, então você pode querer criar um serviço simples próprio que aceite as solicitações do event stream e, em seguida, lide corretamente com seus limites de conexão de terceiros, limites de taxa e fila.
• Muitos serviços têm APIs HTTP públicas, o que significa que você pode se conectar a eles com um event stream; procure seus documentos de API e exemplos de como fazer uma solicitação HTTP para encontrar o lugar certo para começar.

​

Limitações de dados de eventos de mensagem

​

Testes

A URL corresponde à "Your unique URL" de webhook.site

Eventos de mensagem push selecionados, mas qualquer um pode ser usado para testes.

Exemplo usando webhook.site

• Host: o endereço IP de onde a solicitação veio. Consulte Visão geral da API REST para uma lista de IPs possíveis.
• Request Content: os dados enviados dentro do corpo do event stream.