Criar um webhook Braze-para-Braze

Os webhooks Braze-para-Braze permitem chamar a REST API da Braze de dentro da Braze usando um Webhook em uma Campaign ou Canvas. Use isso para tarefas de orquestração, como disparar um Canvas acionado por API. Para atualizar atributos de usuário, eventos personalizados ou compras a partir do Canvas, use a Atualização de usuário em vez disso. Ela foi projetada para alterações no perfil de usuário e processa atualizações de forma mais eficiente.

Para aproveitar ao máximo este artigo, você deve estar familiarizado com como os webhooks funcionam e como criar um webhook na Braze.

Use a Atualização de usuário para alterações em dados de usuários

Para atualizar perfis de usuário de dentro de um Canvas, incluindo modificar atributos personalizados, registrar eventos personalizados ou registrar compras, use a Atualização de usuário em vez de um webhook Braze-para-Braze.

A Atualização de usuário agrupa várias alterações e as envia em lotes, tornando-a mais rápida do que webhooks. É mais fácil de configurar do que um webhook e suporta atualizações complexas por meio do criador avançado de JSON. Por exemplo, para contar quantas vezes um usuário viu uma mensagem, use o recurso de incremento e decremento da Atualização de usuário em vez de um webhook Braze-para-Braze.

Quando usar um webhook Braze-para-Braze

A Atualização de usuário pode lidar com quase todas as mesmas tarefas que um webhook Braze-para-Braze para atualizar perfis de usuário. Para atualizações complexas além de atributos personalizados simples, você pode usar o criador avançado de JSON.

Você pode usar um webhook Braze-para-Braze quando precisar chamar a REST API da Braze de dentro da Braze para cenários diferentes de atualizações diretas de usuário a partir de etapas do Canvas. Exemplos comuns incluem:

• Disparar um Canvas acionado por API a partir de outro Canvas
• Chamar outros endpoints de envio de mensagens para padrões de orquestração em que um fluxo de trabalho na Braze precisa invocar uma API que não possui um componente dedicado do Canvas

Para atualizações de usuário dentro do Canvas, o método recomendado é usar a Atualização de usuário.

Pré-requisitos

Para criar um webhook Braze-para-Braze, você precisa de uma chave de API com permissões para o endpoint que deseja acessar. Por exemplo, para disparar um Canvas acionado por API, você precisa de uma chave de API com a permissão canvas.trigger.send.

Configurando seu webhook Braze-para-Braze

O fluxo de trabalho geral para criar um webhook Braze-para-Braze segue estas etapas:

1. Crie um webhook como uma Campaign ou componente do Canvas.
2. Escolha Blank Template.
3. Na guia Redigir, especifique a Webhook URL e o Request Body para o seu caso de uso da API.
4. Na guia Configurações, especifique o HTTP Method e os Request Headers conforme exigido pelo endpoint.
5. Configure quaisquer definições adicionais de entrega (por exemplo, disparo a partir de um evento personalizado) e construa o restante da sua Campaign ou Canvas.

Disparar um segundo Canvas a partir de um Canvas inicial

Neste caso de uso, você cria dois Canvas e usa um webhook Braze-para-Braze para disparar o segundo Canvas a partir do primeiro. Isso funciona como um gatilho de entrada para quando um usuário atinge um determinado ponto em outro Canvas.

1. Comece criando seu segundo Canvas — o Canvas que deve ser disparado pelo seu Canvas inicial.
2. Para o Cronograma de entrada do Canvas, selecione API-Triggered.
3. Anote o Canvas ID. Você precisará dele em uma etapa posterior.
4. Continue construindo as etapas do seu segundo Canvas e salve o Canvas.
5. Por fim, crie seu primeiro Canvas. Encontre a etapa em que deseja disparar o segundo Canvas e crie uma nova etapa com um webhook.

Consulte as informações a seguir ao configurar seu webhook:

• Webhook URL: A URL do endpoint REST seguida de /canvas/trigger/send. Por exemplo, para a instância US-06, a URL seria https://rest.iad-06.braze.com/canvas/trigger/send.
• Request Body: Raw Text

Cabeçalhos e método da solicitação

A Braze requer um cabeçalho HTTP para autorização que inclua sua chave de API e outro que declare o tipo de conteúdo.

• Request Headers:
  • Authorization: Bearer YOUR_API_KEY
  • Content-Type: application/json
• HTTP Method: POST

Substitua YOUR_API_KEY por uma chave de API da Braze que tenha permissões canvas.trigger.send. Você pode criar uma chave de API no dashboard da Braze acessando Configurações > Chaves de API.

Corpo da solicitação

Adicione sua solicitação /canvas/trigger/send no campo de texto. Para mais detalhes, consulte Envio de mensagens do Canvas via entrega acionada por API. A seguir está um exemplo do corpo da solicitação para este endpoint, onde your_canvas_id é o Canvas ID do seu segundo Canvas:

1
2
3
4
5
6
7
8
{
  "canvas_id": "your_canvas_id",
  "recipients": [
    {
      "external_user_id": "{{${user_id}}}"
    }
  ]
}

Quando um usuário atinge esta etapa de webhook no primeiro Canvas, a Braze dispara o segundo Canvas para esse usuário via API.

Considerações

• Atualizações de usuário: Para atualizar perfis de usuário a partir do Canvas (atributos, eventos, compras), use a Atualização de usuário em vez de webhooks Braze-para-Braze para maior eficiência e custo-benefício.
• Os webhooks Braze-para-Braze estão sujeitos aos limites de taxa dos endpoints.
• Atualizações no perfil de usuário consomem pontos de dados que contam para o seu consumo total, enquanto disparar outra mensagem por meio dos endpoints de envio de mensagens não consome.
• Para segmentar usuários anônimos, use braze_id em vez de external_id no corpo da solicitação do seu webhook.
• Você pode salvar seu webhook Braze-para-Braze como um modelo de webhook para reutilização.
• Você pode verificar o Registro de atividades de envio de mensagem para visualizar e solucionar problemas de falhas de webhook.