Criação de uma campanha de webhook

A criação de uma campanha de webhook ou a inclusão de um webhook em uma campanha multicanal permite disparar ações não relacionadas a aplicativos, fornecendo a outros sistemas e aplicativos informações em tempo real.

Você pode usar webhooks para enviar informações para sistemas, como Salesforce ou Marketo, ou para seus sistemas back-end. Por exemplo, talvez você queira creditar uma promoção nas contas de seus clientes depois que eles realizarem um evento personalizado um determinado número de vezes.

Etapa 1: Escolha onde construir sua mensagem

Não tem certeza se sua mensagem deve ser enviada por meio de uma campanha ou de um Canva? As campanhas são melhores para campanhas de mensagens únicas e simples, enquanto as canvas são melhores para jornadas de usuários em várias etapas.

• campanha
• canvas

Etapa 2: Crie seu webhook

Você pode optar por criar um webhook do zero, usar um modelo existente ou usar um de nossos modelos existentes. Em seguida, crie seu webhook na guia Compose (Criar ) do editor.

A guia Criador consiste nos seguintes campos:

• Idioma
• URL do webhook
• Método HTTP
• Corpo da solicitação

Idioma

A internacionalização é compatível com o URL e o corpo da solicitação. Para internacionalizar sua mensagem, selecione Adicionar idiomas e preencha os campos obrigatórios.

Recomendamos selecionar seus idiomas antes de escrever seu conteúdo para que possa preencher o texto onde ele pertence no Liquid. Para ver a lista completa de idiomas disponíveis que você pode usar, consulte Idiomas suportados.

URL do webhook

O URL do webhook, ou URL HTTP, especifica seu endpoint. O endpoint é o local para o qual você enviará as informações que está capturando no webhook.

Se quiser enviar informações a um fornecedor, ele deverá fornecer esse URL em sua documentação da API. Se estiver enviando informações para seus próprios sistemas, verifique com sua equipe de desenvolvimento ou engenharia para confirmar se está usando o URL correto.

A Braze só permite URLs que se comunicam pelas portas padrão 80 (HTTP) e 443 (HTTPS).

Usando Liquid

Você pode personalizar seus URLs de webhook usando o Liquid. Às vezes, determinados pontos de extremidade podem exigir que você identifique um usuário ou forneça informações específicas do usuário como parte do seu URL. Ao usar o Liquid, inclua um valor padrão para cada informação específica do usuário usada no URL.

Método HTTP

O método HTTP que você deve usar varia de acordo com o endpoint para o qual você está enviando informações. Na maioria dos casos, você usará o POST.

Corpo da solicitação

O corpo da solicitação é a informação que será enviada para o URL que você especificou. Você pode criar o corpo da sua solicitação de webhook com pares de valores-chave JSON ou texto bruto.

Pares de valores-chave JSON

Os pares de valores-chave JSON permitem que você escreva facilmente uma solicitação para um endpoint que espera um formato JSON. Você só pode usar isso com um ponto de extremidade que espera uma solicitação JSON. Por exemplo, se sua chave for message_body, o valor correspondente poderá ser Your order just arrived!. Depois de inserir seu par chave/valor, o criador configurará sua solicitação na sintaxe JSON, e uma prévia de sua solicitação JSON será preenchida automaticamente.

É possível personalizar seus pares de valores-chave usando o Liquid, como incluir qualquer atributo de usuário, atributo personalizado ou propriedade de evento em sua solicitação. Por exemplo, você pode incluir o nome e o e-mail de um cliente em sua solicitação. Não se esqueça de incluir um valor padrão para cada atribuição.

Texto bruto

A opção de texto bruto lhe dá a flexibilidade de escrever uma solicitação para um ponto de extremidade que espera um corpo de qualquer formato. Por exemplo, você pode usar isso para escrever uma solicitação para um ponto de extremidade que espera que sua solicitação esteja no formato XML.

Tanto a personalização quanto a internacionalização usando Liquid são suportadas em texto bruto.

Se você definir o cabeçalho da solicitação Content-Type como application/x-www-form-url-encoded, o corpo da solicitação deverá ser formatado como uma string codificada por URL. Por exemplo:

1
to={{custom_attribute.${example}}}&text=Your+order+just+arrived

Etapa 3: Configurar definições adicionais

Cabeçalhos de solicitação (opcional)

Alguns endpoints podem exigir que você inclua cabeçalhos em sua solicitação. Na seção Compose do criador, é possível adicionar quantos cabeçalhos forem necessários.

Os cabeçalhos de solicitação comuns são as especificações Content-Type (que descrevem o tipo de dados a serem esperados no corpo, como XML ou JSON) e os cabeçalhos de autorização que contêm suas credenciais com seu fornecedor ou sistema.

As especificações de tipo de conteúdo devem usar a chave Content-Type. Os valores comuns são application/json ou application/x-www-form-urlencoded.

Os cabeçalhos de autorização devem usar a chave Authorization. Os valores comuns são Bearer {{YOUR_TOKEN}} ou Basic {{YOUR_TOKEN}} , em que YOUR_TOKEN são as credenciais fornecidas por seu fornecedor ou sistema.

Etapa 4: Teste o envio de suas mensagens

Antes de colocar sua campanha ativa, o Braze recomenda que você teste o webhook para garantir que a solicitação esteja formatada corretamente.

Para isso, vá para a guia Teste e envie um webhook de teste. É possível testar o webhook como um usuário aleatório, um usuário específico (inserindo seu endereço de e-mail ou ID de usuário externo) ou um usuário personalizado com atributos de sua escolha.

Depois de enviar o webhook de teste, será exibida uma caixa de diálogo com a mensagem de resposta. Se a solicitação do webhook não for bem-sucedida, consulte a mensagem de erro para obter ajuda na solução de problemas do webhook. O exemplo a seguir detalha a resposta de um webhook com um URL de webhook inválido.

1
2
3
4
5
6
7
8
9
404 Not Found

{
  "error": {
    "message": "Unrecognized request URL. Please see https://lob.com/docs or email us at [email protected].",
    "status_code": 404
  }
}

Etapa 5: Crie o restante de sua campanha ou Canva

• campanha
• canvas

Etapa 6: Revisão e implementação

Depois de terminar de criar a última parte de sua campanha ou Canva, revise seus detalhes, teste-a e envie-a!

Coisas para saber

Erros, lógica de nova tentativa e tempos limite

Os webhooks dependem de servidores Braze que fazem solicitações a um endpoint externo, e podem ocorrer erros de sintaxe e outros. A primeira etapa para evitar erros de webhook é testar sua campanha de webhook quanto a erros de sintaxe e certificar-se de que as variáveis personalizadas tenham um valor padrão. No entanto, os webhooks ainda podem falhar devido a problemas como chaves de API expiradas, limites de frequência ou erros inesperados do servidor. Se o seu webhook não conseguir enviar, uma mensagem de erro será registrada no Message Activity Log.

Essa descrição contém a hora em que o erro ocorreu, o nome do app e a mensagem de erro:

Se o corpo da mensagem não for suficientemente claro em relação à origem do erro, verifique a documentação do endpoint da API que está usando. Normalmente, eles fornecem uma explicação dos códigos de erro que o endpoint usa, bem como a causa típica desses erros.

Como em outras campanhas, o Braze rastreia a entrega de suas campanhas de webhook e as conversões resultantes delas. Quando a solicitação do webhook for enviada, o servidor receptor retornará um código de resposta indicando o que aconteceu com a solicitação.

A tabela a seguir resume as diferentes respostas que o servidor pode enviar, como elas afetam a análise de dados da campanha e se, no caso de erros, o Braze tentará reenviar a campanha:

Lista de permissões de IP

Quando um webhook é enviado pelo Braze, os servidores do Braze fazem solicitações de rede aos nossos clientes ou a servidores de terceiros. Com a lista de permissões de IP, você pode verificar se as solicitações de webhook são provenientes da Braze, adicionando uma camada de segurança.

O Braze enviará webhooks dos seguintes IPs. Os IPs listados são automática e dinamicamente adicionados a quaisquer chaves de API que tenham sido aceitas para a listagem de permissões.

Uso de webhooks com parceiros do Braze

Há muitas maneiras de usar webhooks e, com nossos parceiros de tecnologia (Alloys), é possível usar webhooks para elevar o nível da comunicação diretamente com seus clientes e usuários.

Confira:

• Messenger
• Remerge
• Lob.com
• E muitos outros de nossos parceiros de tecnologia!