Criando uma transformação

A transformação de dados do Braze permite que você crie e gerencie integrações de webhook para automatizar o fluxo de dados de plataformas externas para o Braze. Essas integrações de webhook podem então alimentar casos de uso de marketing ainda mais sofisticados. Você pode construir sua Transformação de Dados a partir do código padrão ou usando nossa biblioteca de modelos dedicada para ajudá-lo a começar com certas plataformas externas.

Pré-requisitos

Etapa 1: Identificar uma plataforma de origem

Identifique uma plataforma externa que você deseja conectar à Braze e verifique se a plataforma aceita webhooks. Essas configurações às vezes são chamadas de “notificações de API” ou “solicitações de serviço da Web”.

O seguinte é um exemplo webhook do Typeform, que é configurável ao fazer login na plataforma deles:

Etapa 2: Criar uma transformação

In the Braze dashboard, go to Data Settings > Data Transformation.

Select Create Transformation to name your transformation, then choose your editing experience.

Select Use a template to browse through a template library, including Data Transformation use cases. Or, select Start from scratch to load a default code template.

If you’re starting from scratch, choose a destination for your transformation. You can still insert a code template from the template library.

After creating your transformation, you’ll see the detailed view of the transformation. Here, you can view the most recent webhook received for this transformation under Webhook details and a space to write your transformation code under Transformation code.

Etapa 3: Enviar um webhook de teste (recomendado)

Esta etapa é opcional, mas recomendamos enviar um webhook de teste da sua plataforma de origem para sua transformação recém-criada.

1. Copie a URL da sua transformação.
2. Na sua plataforma de origem, encontre a capacidade de “Enviar Teste” para que ela gere um webhook de amostra para enviar para este URL.
   • Se a sua plataforma de origem solicitar um tipo de solicitação, selecione POST.
   • Se a sua plataforma de origem fornecer opções de autenticação, selecione Sem autenticação.
   • Se a sua plataforma de origem pedir segredos, selecione Nenhum segredo.
3. Atualize sua página no dashboard do Braze para ver se o webhook foi recebido. Se tiver sido recebido, você deverá ver uma carga útil de webhook em Most recent webhook (Webhook mais recente).

Aqui está como fica para o Typeform:

Etapa 4: Escreva o código de transformação

Se você tem pouca ou nenhuma experiência com código JavaScript ou prefere instruções mais detalhadas, siga o Iniciante - POST: Rastrear usuários ou Iniciante - PUT: Atualize vários itens do catálogo guia para escrever seu código de transformação.

Se você é um desenvolvedor ou tem experiência significativa com código JavaScript, siga o Avançado - POST: Acompanhe os usuários guia para instruções de alto nível sobre como escrever seu código de transformação.

• iniciante - usuários de rastreamento
• iniciante - atualizar itens do catálogo
• avançado - rastreamento de usuários

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// Here, we will define a variable, "brazecall", to build up a `/users/track` request
// Everything from the incoming webhook is accessible via the special variable "payload"
// So you can template in desired values in your `/users/track` request with dot notation, such as payload.x.y.z

let brazecall = {
  "attributes": [
    {
      "external_id": payload.user_id,
      "_update_existing_only": true,
      "attribute_1": payload.attribute_1
    }
  ],
  "events": [
    {
      "external_id": payload.user_id,
      "_update_existing_only": true,
      "name": payload.event_1,
      "time": new Date(),
      "properties": {
        "property_1": payload.event_1.property_1
      }
    }
  ],
  "purchases": [
    {
      "external_id": payload.user_id,
      "_update_existing_only": true,
      "product_id": payload.product_id,
      "currency": payload.currency,
      "price": payload.price,
      "quantity": payload.quantity,
      "time": payload.timestamp,
      "properties": {
        "property_1": payload.purchase_1.property_1
      }
    }
  ]
};

// After the /users/track request is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
// This is a default template that you can use as a starting point
// Feel free to delete this entirely to start from scratch, or to edit specific components

// First, this code defines a variable, "brazecall", to build a PUT /catalogs/{catalog_name}/items request
// Everything from the incoming webhook is accessible via the special variable "payload"
// As such, you can template in desired values in your request with JS dot notation, such as payload.x.y.z

let brazecall = {
  // For Braze Data Transformation to update Catalog items, the special variable "catalog_name" is required
  // This variable is used to specify the catalog name which would otherwise go in the request URL
  "catalog_name": "catalog_name",
  
  // After defining "catalog name", construct the Update Multiple Catalog Items request as usual below
  // Documentation for the destination endpoint: https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/asynchronous/put_update_catalog_items/
  "items": [
    {
      "id": payload.item_id_1,
      "catalog_column1": "string",
      "catalog_column2": 1,
      "catalog_column3": true,
      "catalog_column4": "2021-09-03T09:03:19.967+00:00",
      "catalog_column5": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      }
    },
    {
      "id": payload.item_id_2,
      "catalog_column1": "string",
      "catalog_column2": 1,
      "catalog_column3": true,
      "catalog_column4": "2021-09-03T09:03:19.967+00:00",
      "catalog_column5": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      }
    },
    {
      "id": payload.item_id_3,
      "catalog_column1": "string",
      "catalog_column2": 1,
      "catalog_column3": true,
      "catalog_column4": "2021-09-03T09:03:19.967+00:00",
      "catalog_column5": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      }
    }
  ]
};

// After the request body is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

Etapa 5: Monitore sua transformação

Depois de ativar sua transformação, consulte a análise de dados na página principal de Transformações para obter um resumo da performance.

• Solicitações Recebidas: Este é o número de webhooks recebidos na URL desta transformação. Se as solicitações recebidas forem 0, sua plataforma de origem não enviou nenhum webhook ou a conexão não pôde ser estabelecida.
• Entregas: Após receber solicitações de entrada, a Transformação de Dados aplica seu código de transformação para enviar ao seu destino Braze selecionado.

É uma boa meta ter 100% das solicitações recebidas levando a entregas. O número de entregas nunca excederá o número de solicitações recebidas.

Solução de problemas

Para monitoramento e solução de problemas mais detalhados, consulte a página Logs para obter registros específicos, onde são registradas as últimas 1.000 solicitações de entrada para todas as transformações em seus espaços de trabalho. É possível selecionar cada registro para visualizar o corpo da solicitação de entrada, a saída da transformação e o corpo da resposta dos destinos da transformação.

Se não houver entregas, verifique se há erros de sintaxe no código de transformação e confirme se o código está sendo compilado. Em seguida, verifique se a saída é uma solicitação de destino válida.

Entregas menores que o número de solicitações recebidas indicam que pelo menos alguns webhooks foram entregues com êxito. Consulte os logs de transformação para erros de exemplo e veja se a saída da transformação é a esperada. É possível que seu código de transformação não esteja considerando todas as variações de webhooks recebidas.