Pular para o conteúdo principal

Visão geral

A integração OneSignal + Confluent Cloud permite a sincronização automática de eventos personalizados dos seus tópicos gerenciados do Kafka para o OneSignal. Isso permite que você acione Jornadas automatizadas e campanhas de mensagens personalizadas com base em dados comportamentais de usuários em tempo real fluindo através da sua plataforma de streaming Confluent Cloud.

Requisitos

  • Acesso a Event Streams para eventos de mensagem de saída (Limitações de plano e excedentes se aplicam)
  • Acesso a Custom Events para sincronização de eventos de entrada (Limitações de plano e excedentes se aplicam)
  • Plano de Conta Atualizado (não disponível em apps gratuitos)

Confluent Cloud

  • Cluster do Confluent Cloud com tópicos ativos
  • Credenciais de API com acesso de leitura aos tópicos de eventos
  • Schema Registry (opcional, para esquemas de eventos estruturados)
  • Tópicos de eventos contendo dados comportamentais com formato de mensagem apropriado

Configuração

1

Criar credenciais de API no Confluent Cloud

Gere credenciais de API para o OneSignal no seu console Confluent Cloud:
  1. Navegue até Data Integration > API Keys no Confluent Cloud
  2. Clique em Create key e selecione Global access
  3. Salve a API Key e API Secret (você precisará delas para o OneSignal)
  4. Anote o endpoint de Bootstrap servers das configurações do seu cluster
2

Configurar ACLs de tópico (se usar permissões granulares)

Conceda ao OneSignal acesso de leitura a tópicos específicos contendo dados de eventos:
confluent kafka acl create \
  --allow \
  --service-account <ONESIGNAL_SERVICE_ACCOUNT_ID> \
  --operation READ \
  --topic <EVENT_TOPIC_NAME>

confluent kafka acl create \
  --allow \
  --service-account <ONESIGNAL_SERVICE_ACCOUNT_ID> \
  --operation DESCRIBE \
  --topic <EVENT_TOPIC_NAME>
3

Adicionar integração no OneSignal

No OneSignal, vá para Data > Integrations e clique em Add Integration.Selecione Confluent Cloud e forneça:
  • Bootstrap Servers: Endpoint do seu cluster Confluent Cloud
  • API Key: Chave de API do Confluent Cloud
  • API Secret: Segredo de API do Confluent Cloud
  • Consumer Group: ID de grupo único para o OneSignal (por exemplo, onesignal-events)
  • Schema Registry URL (opcional): Se usar Confluent Schema Registry
4

Configurar tópicos de eventos

Especifique os tópicos do Confluent Cloud contendo seus dados de eventos:
  • Topic Names: Lista separada por vírgulas de tópicos a consumir (por exemplo, user-events,purchase-events)
  • Event Format: Formato de mensagem JSON, Avro ou Protobuf
  • Schema Registry: Habilite se usar esquemas estruturados
Suas mensagens de eventos devem conter:
  • Nome/tipo do evento (String)
  • Identificador do usuário (String)
  • Timestamp do evento (Long/formato ISO)
  • Propriedades adicionais do evento (JSON aninhado)
5

Testar a conexão

Clique em Test Connection para verificar se o OneSignal pode se conectar ao seu cluster Confluent Cloud e consumir mensagens de eventos.

Mapeamento de dados de evento

Mapeie seu para o formato de eventos personalizados do OneSignal:
Campo OneSignalDescriçãoObrigatório
nameevent_nameIdentificador de eventoSim
external_iduser_idIdentificador de usuárioSim
timestampevent_timestampQuando o evento ocorreuNão
propertiesevent_dataNão

Configuração avançada

Integração com Schema Registry

Aproveite o Confluent Schema Registry para dados de eventos estruturados:
{
  "schema": "user_event_schema_v1",
  "data": {
    "event_name": "purchase",
    "user_id": "user_12345",
    "event_timestamp": 1640995200000,
    "properties": {
      "product_id": "prod_abc123",
      "amount": 29.99,
      "currency": "USD"
    }
  }
}

Gerenciamento de Consumer Group

O OneSignal cria um grupo de consumidores dedicado para rastrear offsets de mensagens:
  • Auto-commit: Offsets confirmados automaticamente após processamento bem-sucedido
  • Tratamento de erros: Mensagens com falha registradas com mecanismo de retry
  • Escalabilidade: Partições balanceadas entre instâncias de consumidores do OneSignal

Processamento em tempo real

O Confluent Cloud permite ativação de eventos quase em tempo real:
  • Baixa latência: Eventos processados em segundos após serem publicados
  • Alto throughput: Lida com milhares de eventos por segundo
  • Tolerância a falhas: Replicação integrada e failover automático
Certifique-se de que seu cluster Confluent Cloud tenha capacidade de throughput suficiente para lidar com a taxa de consumo do OneSignal juntamente com seus outros consumidores.

FAQ

Com que frequência o OneSignal consome eventos do Confluent Cloud?

O OneSignal consome eventos em tempo real à medida que chegam aos seus tópicos, com latência mínima (tipicamente menos de 5 segundos).

Posso consumir de múltiplos tópicos simultaneamente?

Sim, o OneSignal pode consumir de múltiplos tópicos em paralelo. Especifique nomes de tópicos como uma lista separada por vírgulas na configuração.

O que acontece se o OneSignal não conseguir se conectar ao Confluent Cloud?

O OneSignal tentará reconectar com backoff exponencial. O consumo de eventos será retomado automaticamente assim que a conectividade for restaurada.