Webhooks
Webhooks são uma maneira comum para aplicativos se comunicarem — compartilhando dados em tempo real. Hoje em dia, raramente temos um aplicativo autônomo que consiga fazer tudo. Na maioria das vezes, você trabalha com vários aplicativos ou sistemas diferentes, cada um especializado em realizar determinadas tarefas, e todos eles precisam ser capazes de se comunicar entre si. É aí que os webhooks entram.
Um webhook é uma mensagem automatizada de um sistema para outro quando determinados critérios são atendidos. Na Braze, esse critério geralmente é o disparo de um evento personalizado.
Essencialmente, um webhook é um método baseado em eventos que permite que dois sistemas separados tomem ações eficazes com base nos dados transmitidos em tempo real. Essa mensagem contém instruções que informam ao sistema receptor quando e como realizar uma tarefa específica. Por isso, os webhooks podem oferecer um acesso mais dinâmico e flexível aos dados e à funcionalidade programática, além de permitir que você configure jornadas de clientes que otimizam processos.
A disponibilidade dos webhooks depende do seu pacote Braze. Entre em contato com seu gerente de conta ou gerente de sucesso do cliente para começar.
Artigos da seção
Casos de uso
Webhooks são uma excelente maneira de conectar seus sistemas — afinal, é assim que os aplicativos se comunicam. Veja alguns cenários gerais em que webhooks podem ser particularmente úteis:
- Enviar dados para a Braze e receber dados da Braze
- Enviar mensagens para seus clientes por canais não suportados diretamente pela Braze
- Fazer chamadas para as APIs da Braze
Alguns casos de uso mais específicos incluem:
- Se um usuário cancelar a inscrição de e-mail, você pode usar um webhook para atualizar seu banco de dados de análise de dados ou CRM com essa mesma informação, garantindo uma visão completa do comportamento desse usuário.
- Envie mensagens transacionais para usuários no Facebook Messenger ou LINE.
- Envie mala direta para os clientes em resposta à atividade deles no app e na web, usando webhooks para se comunicar com serviços de terceiros como o Lob.com.
- Se um jogador atingir um determinado nível ou acumular certa quantidade de pontos, use webhooks e sua configuração de API existente para enviar um upgrade de personagem ou moedas diretamente para a conta dele. Se você enviar o webhook como parte de uma campanha de mensagens em vários canais, pode enviar um push ou outra mensagem para informar o jogador sobre a recompensa ao mesmo tempo.
- Se você é uma companhia aérea, pode usar webhooks e sua configuração de API existente para creditar a conta de um cliente com um desconto após ele ter reservado um determinado número de voos.
- Receitas infinitas do tipo “If This Then That” (IFTTT) — por exemplo, se um cliente entrar no app via e-mail, esse endereço pode ser configurado automaticamente no Salesforce.
Anatomia de um webhook
Um webhook é composto pelas seguintes partes:
| Parte do webhook | Descrição |
|---|---|
| Método HTTP | Assim como as APIs, webhooks precisam de métodos de solicitação. Eles são atribuídos à URL que o webhook aciona e informam ao endpoint o que fazer com as informações fornecidas. Existem quatro métodos HTTP que você pode especificar: POST, GET, PUT e DELETE. |
| URL HTTP | O endereço URL do seu endpoint de webhook. O endpoint é o local para onde você enviará as informações capturadas no webhook. |
| Corpo da solicitação | Essa parte do webhook contém as informações que você está comunicando ao endpoint. O corpo da solicitação pode ser pares de chave-valor JSON ou texto bruto. |
Métodos HTTP
A tabela a seguir descreve os quatro métodos HTTP diferentes que você pode especificar no seu webhook.
| Método HTTP | Descrição |
|---|---|
| POST | Este método grava novas informações no servidor receptor. Um exemplo comum do método POST em uma aplicação do mundo real é um formulário de contato em um site. Qualquer informação que você inserir no formulário se torna parte do corpo da solicitação e é enviada a um receptor. Este é o método mais comum para enviar dados. |
| GET | Este método recupera informações existentes, em vez de gravar novas. Por definição, uma solicitação GET não suporta corpo de solicitação. Este é o método mais comum para solicitar dados de um servidor. Por exemplo, considere o endpoint /segments/list. Se você fizesse uma solicitação GET, ela retornaria uma lista dos seus segmentos. |
| PUT | Este método atualiza as informações no endpoint, substituindo qualquer informação existente pelo conteúdo do corpo da solicitação. |
| DELETE | Este método exclui o recurso na URL HTTP. |
Webhooks na Braze
Na Braze, você pode criar um webhook como uma campanha de webhook, campanha de API ou componente do Canvas.
- No dashboard da Braze, acesse Campanhas.
- Clique em Criar campanha e selecione Webhook.
Consulte Criar um webhook para saber mais.
- No dashboard da Braze, acesse Campanhas.
- Clique em Criar campanha e selecione Campanha de API.
- Clique em Adicionar mensagens e selecione Webhook.
- Formate sua chamada de API para incluir um objeto webhook.
Consulte Criar um webhook para saber mais.
- No seu Canvas, crie um novo componente.
- Na seção Mensagem do seu componente, selecione Webhook.
Consulte Criar um webhook para saber mais.
Tratamento de erros e limite de taxa de webhooks
Quando a Braze recebe uma resposta de erro de uma chamada de webhook, o comportamento de envio desse webhook é ajustado automaticamente com base nestes cabeçalhos de resposta:
Retry-AfterX-Rate-Limit-LimitX-Rate-Limit-RemainingX-Rate-Limit-Reset
Esses cabeçalhos nos ajudam a interpretar os limites de taxa e ajustar a velocidade de envio para evitar mais erros. Também implementamos uma estratégia de backoff exponencial para novas tentativas, o que ajuda a reduzir o risco de sobrecarregar seus servidores ao espaçar as tentativas ao longo do tempo.
Se detectarmos que a maioria das solicitações de webhook para um host específico está falhando, adiaremos temporariamente todas as tentativas de envio para esse host. Em seguida, retomaremos o envio após um período de espera definido, permitindo que seu sistema se recupere.