Criando uma transformação

O Braze Data Transformation 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 webhooks podem, então, potencializar casos de uso de marketing ainda mais sofisticados. Você pode criar sua transformação de dados a partir do código padrão ou usar nossa biblioteca de modelos dedicada para ajudá-lo a começar com determinadas plataformas externas.

Pré-requisitos

Etapa 1: Identificar uma plataforma de origem

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

A seguir, um exemplo de webhook do Typeform, que pode ser configurado ao fazer login na plataforma:

!

Etapa 2: Criar uma transformação

No painel da Braze, acesse Configurações de Dados > Transformação de Dados.

Selecione Criar Transformação para nomear sua transformação, em seguida escolha sua experiência de edição.

Selecione Usar um modelo para navegar por uma biblioteca de modelos, incluindo casos de uso de Transformação de Dados. Ou, selecione Começar do zero para carregar um modelo de código padrão.

Se você está começando do zero, escolha um destino para sua transformação. Você ainda pode inserir um modelo de código da biblioteca de modelos.

Após criar sua transformação, você verá a visão detalhada da transformação. Aqui, você pode visualizar o webhook mais recente recebido para esta transformação em Detalhes do webhook e um espaço para escrever seu código de transformação em Código de transformação.

Capture seu Webhook URL para uso na próxima etapa.

Etapa 3: Enviar um webhook de teste (recomendado)

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

1. Copie o URL de sua transformação.
2. Em sua plataforma de origem, localize um recurso “Send Test” (Enviar teste) para que ele gere um webhook de amostra a ser enviado para essa URL.
   • Se sua plataforma de origem solicitar um tipo de solicitação, selecione POST.
   • Se sua plataforma de origem fornecer opções de autenticação, selecione Sem autenticação.
   • Se sua plataforma de origem solicitar segredos, selecione No secrets (Sem segredos).
3. Atualize sua página no painel do Braze para ver se o webhook foi recebido. Se ele foi recebido, você deverá ver uma carga de webhook em Most recent webhook (Webhook mais recente).

Esta é a aparência do Typeform:

Exemplo de código de transformação de dados que mapeia o webhook para os perfis de usuário do Braze.](/docs/pt-br/assets/img/data_transformation/data_transformation11.png?6c5d5b2bc70dc2fd02f05bb5f960e9b5)

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

Se você tiver pouca ou nenhuma experiência com código JavaScript ou se preferir instruções mais detalhadas, siga o site Beginner - 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ê for um desenvolvedor ou tiver experiência significativa com código JavaScript, siga o endereço Advanced - POST: Acompanhe os usuários na guia para obter instruções de alto nível sobre como escrever seu código de transformação.

• beginner - track users
• beginner - update catalog items
• advanced - track users

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 as análises na página principal de Transformações para obter um resumo do desempenho.

• Solicitações recebidas: Esse é o número de webhooks recebidos no URL dessa transformação. Se as solicitações de entrada forem 0, sua plataforma de origem não enviou nenhum webhook ou a conexão não pode ser feita.
• Entregas: Depois de receber as solicitações, o Data Transformation aplica seu código de transformação para enviar ao destino Braze selecionado.

É uma boa meta ter 100% das solicitações recebidas resultando em 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 logs 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. Você pode selecionar cada registro para visualizar o corpo da solicitação de entrada, a saída da transformação e o corpo da resposta do destino da transformação.

Se não houver entregas, verifique se há erros de sintaxe em seu 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 registros de transformação para ver exemplos de erros e verifique se a saída da transformação é a esperada. É possível que seu código de transformação não esteja levando em conta todas as variações de webhooks recebidos.