Pular para o conteúdo principal

Visão geral

Webhooks BlueConic permitem que você sincronize dados de perfil ou segmento para o OneSignal em tempo real sempre que eventos específicos ocorrem no seu site. Este guia demonstra como configurar o BlueConic para enviar dados ao OneSignal via API Update user.

Requisitos

Configuração

Para sincronizar dados de usuário entre BlueConic e OneSignal, um identificador comum deve existir para associar usuários em ambas as plataformas. O BlueConic gera um identificador único chamado BlueConic ID, que pode ser vinculado a um usuário no OneSignal para sincronizar dados.

Script de atualização

Recomendamos criar um alias personalizado para identificar seus usuários usando seus IDs BlueConic. Antes de atribuir um novo alias, certifique-se de que o usuário está logado no OneSignal primeiro. O código a seguir fornece exemplos de associação de um BlueConic ID com um usuário OneSignal usando um Alias e um ID Externo.
// Get the BlueConic ID
const blueConicId = blueConicClient.profile.getProfile().getId();

// Ensure the user is logged in
// Logged in users will have an External ID
if (!OneSignal.User.externalId) {
await OneSignal.login("EXTERNAL_ID_FROM_YOUR_BACKENED");
}

// External ID must exist before calling this method
OneSignal.User.addAlias('blueconic_profile_id', blueConicId);

Se seu sistema usa IDs BlueConic como o identificador principal, passe-o para OneSignal.login.
// Get the BlueConic ID
const blueConicId = blueConicClient.profile.getProfile().getId();

// Set OneSignal External ID to BlueConic ID
OneSignal.login(blueConicId);

Adicionar webhooks

Use webhooks para sincronizar dados do BlueConic para o OneSignal com base em suas necessidades específicas. Os exemplos abaixo demonstram como usar a API Update user para conseguir isso. Detalhes da API
URLhttps://api.onesignal.com/apps/<APP_ID>/users/by/alias_label/alias_value
MethodPATCH
AuthorizationBasic <API_KEY>
Se seu sistema usa o BlueConic ID como o identificador principal… Use a seguinte URL em vez disso: https://api.onesignal.com/apps/<APP_ID>/users/by/external_id/{{blueconic_profile_id}}

Sincronizando propriedades de perfil

Sincronize dados de perfil BlueConic para o OneSignal definindo Tags e outros dados de usuário.

Exemplo de configuração para atualizar tags

Payload
{
  "properties": {
    "tags": {
      "tag_name_at_onesignal": "{{BLUECONIC_PROPERTY}}"
    }
  }
}

Sincronizando segmentos

Sincronize dados de segmento BlueConic para o OneSignal definindo Tags. Use essas tags para criar segmentos diretamente dentro do OneSignal.

Exemplo de configuração para manter segmentos sincronizados

Payload
{
  "properties": {
    "tags": {
      "early_bird": "Yes",
    }
  }
}
Você pode nomear tags com base em necessidades específicas, como early_bird ou qualquer outro rótulo descritivo. No entanto, o valor atribuído à tag deve sempre ser codificado, como Yes, para consistência entre segmentos no BlueConic e OneSignal.