O webhook de entrada permite que você receba dados em tempo real no Brevo de um aplicativo externo. Sempre que um evento acontece no seu aplicativo externo, o Brevo recebe um webhook contendo detalhes do evento. Você pode então:

• Acionar um evento personalizado no Brevo e/ou
• Criar ou atualizar automaticamente um contato com base nos dados recebidos.

É bom saber

• Os webhooks de entrada estão sendo implementados gradualmente e podem não estar disponíveis em todas as contas ainda.
• Você pode criar até 20 webhooks de entrada na sua conta Brevo. Para adicionar um novo webhook além desse limite, exclua um existente.
• Cada URL de webhook pode manipular até 20 eventos por segundo.
• Por enquanto, você só pode recuperar dados do primeiro nível de hierarquia do payload JSON. Isso significa que você pode acessar matrizes e objetos de nível superior diretamente, mas não pode recuperar dados de matrizes aninhadas ou níveis mais profundos.
• Se você deseja criar um webhook de saída para enviar dados em tempo real do Brevo para um aplicativo externo, confira nosso artigo dedicado Novos webhooks - Criar webhooks de saída para enviar dados em tempo real do Brevo para um aplicativo externo.

Etapa 1: criar um webhook de entrada no Brevo

Para começar, você precisa criar um webhook de entrada no Brevo.

1. No Brevo, clique no menu suspenso da conta e selecione Integrations (Integrações).
2. Vá para a guia Webhooks.
3. Clique em Add webhook (Adicionar webhook).
   
4. Selecione Inbound webhook (Webhook de entrada).
5. Clique em Add webhook (Adicionar webhook).
   

Etapa 2: configurar o webhook de entrada no Brevo

Em seguida, configure o webhook de entrada no Brevo.

1. Insira um nome para o webhook.
   
2. Clique em Continue (Continuar).
3. Selecione o método HTTP que você deseja usar para este webhook (POST, GET, PUT ou PATCH).
4. Copie o URL do webhook gerado pelo Brevo. Este URL de retorno informa ao seu aplicativo externo para onde enviar o webhook de entrada quando um evento acontece.
   
5. Cole o URL do webhook no seu aplicativo externo. Isso geralmente é feito em uma página de configuração de webhook, uma seção de automação ou por meio de uma integração de API.
   
   💡 É bom saber

   Caso não tenha certeza de onde colá-lo, verifique a central de ajuda do seu aplicativo externo ou entre em contato com a equipe de suporte.
6. (Opcional) Para adicionar uma camada extra de segurança, ou se seu aplicativo externo exigir:
   1. Ative a opção Require authentication (Exigir autenticação).
   2. Copie o token gerado pelo Brevo.
      
      
      💡 É bom saber

      Se o seu token estiver comprometido, você pode regenerá-lo clicando no ícone de atualização 🔄 e atualizando-o no seu aplicativo externo.
   3. Cole o token no seu aplicativo externo.
7. Conclua as configurações do webhook de entrada no seu aplicativo externo. Você talvez precise selecionar:
   • O evento que vai ativar o webhook.
   • Os dados a serem incluídos na carga útil.

Etapa 3: enviar uma solicitação de teste e escolher a carga útil a ser sincronizada

Teste o webhook de entrada e confirme os dados do evento que estão sendo recebidos.

1. Envie uma solicitação de teste do seu aplicativo externo para o Brevo. 
2. Verifique os dados do evento recebidos para garantir que eles contenham todos os parâmetros que você deseja sincronizar. Se alguma informação estiver faltando, envie solicitações de teste adicionais até que a carga correta seja recebida.
   
3. (Opcional) Se várias solicitações de teste foram enviadas:
   1. Clique em 🔄 Reload (Recarregar).
   2. Use o menu suspenso para selecionar a carga desejada entre as últimas 10 cargas recebidas.
      
4. Clique em Continue (Continuar).

Etapa 4: configurar a ação ativada pelo webhook de entrada

Configure qual ação deve ser acionada no Brevo quando o webhook for recebido. Isso envolve mapear as chaves de carga útil (os dados do evento recebidos no webhook de entrada) para os atributos Brevo para garantir que os dados recebidos sejam formatados corretamente e desencadear a ação correta.

Você pode escolher entre duas ações disponíveis:

• Opção 1: criar um evento
  Acompanhe ações externas no Brevo criando um evento personalizado.
• Opção 2: criar ou atualizar um contato
  Adicione ou atualize automaticamente dados de contato no Brevo.

Uma vez ativado, o webhook de entrada enviará dados do seu aplicativo externo para o Brevo sempre que for ativado. Você pode usar os dados recebidos para executar várias ações, como:

• Segmentar contatos com base em dados de eventos.
• Acionar automações usando eventos customizados.
• Personalize e-mails, SMS ou outras mensagens.

Revise os logs de um webhook de entrada para solucionar problemas

Cada vez que um webhook de entrada é ativado, ele envia dados do seu aplicativo externo para o Brevo, onde as ações webhook são processadas. Você pode revisar os logs de um webhook de entrada para verificar se as ações foram executadas com sucesso e identificar quaisquer possíveis problemas para solução de problemas.

1. No Brevo, clique no menu suspenso da conta e selecione Integrations (Integrações).
2. Vá para a guia Webhooks.
3. Selecione a opção Inbound webhook (Webhook de entrada). Aqui, você encontrará uma visão geral das ações processadas nas últimas 24 horas e seus status para cada webhook de entrada:
   
   • Mapeado: a ação foi processada com sucesso.
   • Não mapeado: ocorreu um erro e a ação não foi processada.
     
4. Clique no nome do webhook de entrada para acessar os logs.
5. Na guia Logs, revise os logs do webhook de entrada:
   
   
   1. Filtrar por status: exiba todas as ações, apenas ações mapeadas ou ações não mapeadas.
   2. Atualizar registros: obtenha os dados mais recentes em tempo real.
   3. Exibir chamadas webhook de entrada: revise o registro de data e hora e a carga processada para cada chamada webhook.
   4. Revise as ações processadas e os atributos: veja quais ações o Brevo manipulou após receber um webhook de entrada e verifique os dados passados para cada ação. Se ocorrer um erro, compare o tipo de chave esperado com o valor recebido.

Desativar um webhook de entrada

Se precisar parar temporariamente de receber dados do seu aplicativo externo, você pode desativar o webhook de entrada.

1. No Brevo, clique no menu suspenso da conta e selecione Integrations (Integrações).
2. Vá para a guia Webhooks.
3. Selecione a opção Inbound webhook (Webhook de entrada).
4. Desative o webhook de entrada que você deseja desativar.
   

O webhook de entrada agora está desativado (botão cinza). Você pode reativá-lo a qualquer momento, ligando-o novamente.

excluir um webhookde entrada

Se você não precisar mais de um webhook de entrada, poderá excluí-lo permanentemente.

1. No Brevo, clique no menu suspenso da conta e selecione Integrations (Integrações).
2. Vá para a guia Webhooks.
3. Selecione a opção Inbound webhook (Webhook de entrada).
4. Ao lado do webhook de entrada que você deseja excluir, clique no ícone de lixeira.
   
5. clique em excluir webhook para confirmar.

O webhook de entrada e seu URL de retorno de chamada associado foram excluídos permanentemente.

⏭️ O que vem a seguir?

• Novo webhook - Crie um webhook de saída para enviar dados em tempo real do Brevo para um aplicativo externo
• enviado webhook de saída de uma automação

🤔 Dúvidas?

Em caso de dúvida, sinta-se à vontade para entrar em contato com nossa equipe de suporte, criando um tíquete a partir da sua conta. Caso ainda não tenha uma conta, entre em contato conosco aqui.

Se você está procurando ajuda com um projeto usando o Brevo, podemos encontrar à agência parceira da Brevo certa.