Os webhooks de saída permitem que você envie dados em tempo real do Brevo para um aplicativo externo. Quando um evento específico acontece no Brevo, seu aplicativo externo receberá uma notificação contendo detalhes do evento.

Você pode criar webhooks de saída para eventos relacionados aos seguintes recursos do Brevo:

É bom saber

• Você pode criar até 40 webhooks de saída na sua conta Brevo. Se você atingir esse limite, exclua um webhook existente antes de criar um novo.
• Os webhooks de saída também podem ser criados usando uma automação ou a API.
• Se você quiser criar webhooks de entrada para receber dados em tempo real de outro aplicativo no Brevo, confira nosso artigo dedicado Criar webhooks de entrada para receber dados em tempo real no Brevo.

Antes de começar

No seu aplicativo externo, recupere:

• O URL do servidor ou ponto de extremidade para o qual você deseja enviar o webhook de saída
• (Opcional) O método de autenticação e as credenciais necessárias
• Qualquer nome e valor de cabeçalho necessário

Se não tiver certeza de onde recuperar essas informações, verifique a central de ajuda do seu aplicativo externo ou entre em contato com a equipe de suporte.

Etapa 1: Crie um webhook de saída no Brevo

Para criar um webhook de saída no Brevo:

1. No Brevo, clique no nome da sua conta e selecione Integrations > Webhooks (Integrações > Webhooks).
2. Clique em Add webhook (Adicionar webhook).
3. Selecione Outbound webhook (Webhook de saída).
4. Clique em Add webhook (Adicionar webhook).

Etapa 2: configurar o webhook de saída

Em seguida, configure o nome, o URL e o método de autenticação do webhook de saída.

1. Insira um nome para o webhook.
2. Clique em Continue (Continuar).
3. Insira a URL do servidor ou ponto de extremidade para o qual você deseja enviar seus eventos. Isso informa ao Brevo para onde enviar o webhook de saída quando um evento acontece.
   
4. (Opcional) Por padrão, No authentication (Nenhuma autenticação) é selecionado como o método de autenticação. Para adicionar uma camada extra de segurança, ou se o aplicativo externo para o qual você está enviando o webhook exigir isso, você pode escolher:
   • Autenticação básica (nome de usuário e senha), ou
   • Autenticação de token
     
5. (Opcional) Para adicionar um cabeçalho ao seu webhook de saída:
   1. Clique em + Add an object (Adicionar um objeto).
   2. Insira o nome e o valor do título.
      
6. Selecione sua estratégia de envio de webhook:
   • Enviar um de cada vez
     Envie eventos individualmente em tempo real.
   • Enviar em lotes
     Envie eventos em lotes de até 500. Isso é recomendado se você tiver limites de taxa mais baixos, pois pode reduzir o número de solicitações.
7. Clique em Continue (Continuar).

Etapa 3: Escolha os eventos e envie as solicitações de teste

Por fim, escolha os eventos para os quais você deseja receber o webhook de saída e enviar solicitações de teste para seu aplicativo externo.

1. Selecione a categoria do evento para o qual deseja criar um webhook de saída (por exemplo, e-mail transacional, oportunidades, formulários etc.).
   
   💡 É bom saber

   Os eventos de contatos estão localizados na categoria E-mails de marketing.
2. Por padrão, todos os eventos dentro da categoria selecionada são ativados. Se necessário, você pode desativar eventos específicos desmarcando-os.
   
3. (Opcional) Para enviar solicitações de teste para os eventos:
   1. Clique no ícone de três pontos ao lado de um evento e selecione Send test request (Enviar solicitação de teste).
      
   2. Verifique seu aplicativo externo para confirmar se você recebeu o webhook de saída.
4. clicado Ative webhook quando terminar.

Proteja seu webhook de saída

Para proteger seu webhook de saída, você precisa colocar alguns intervalos de IP da Brevo na lista de permissões. Isso garante que somente solicitações autorizadas possam ativar o webhook. 

➡️ Para saber mais, confira nosso artigo dedicado Breve intervalo do IP: lista de serviços expostos publicamente.

Monitorar a entrega de webhooks e configurar alertas

Monitore a entrega dos eventos de webhook de saída e configure alertas para receber notificações quando ocorrerem problemas.

Revise suas estatísticas de webhook

O painel de monitoramento ajuda você a acompanhar o status de entrega dos seus eventos de webhook de saída. Isso permite identificar rapidamente problemas de entrega.

Para revisar as estatísticas de eventos do seu webhook de saída:

1. No Brevo, clique no nome da sua conta e selecione Integrations > Webhooks (Integrações > Webhooks).
2. Na guia Outbound webhooks (Webhooks de saída), clique no webhook de saída que você quer monitorar.

3. Em Statistics (Estatística), verifique o status de entrega dos seus eventos de webhook de saída:

   📨 Estados de entrega📊 Gráfico de barras

   

   Veja o número de eventos de webhook de saída nas últimas 24 horas em três estados de entrega:

   • ❌ Falha: o número de eventos de webhook de saída exclusivos que não puderam ser entregues após 24 horas de tentativas e foram descartados.
   • ⚠️ Novas tentativas: o número de eventos exclusivos de webhook de saída que estão sendo tentados novamente no momento nas últimas 24 horas. Para saber mais sobre o mecanismo de novas tentativas, consulte nossa documentação da API dedicada.
   • ✅ Entregues: o número de eventos de webhook de saída exclusivos entregues com sucesso nas últimas 24 horas.

   

   O gráfico de barras das últimas 24 horas mostra o número de eventos de webhook de saída em cada estado com uma divisão por hora. Você pode passar o mouse sobre uma barra para ver o número exato de eventos de webhook de saída exclusivos sendo reenviados, entregues e com falha durante a hora.

Configurar alertas de webhook

Configure alertas por e-mail para ser notificado quando os problemas de entrega de eventos de webhook de saída atingirem um limite definido. Os alertas são enviados para o e-mail padrão da sua conta, com no máximo uma notificação por hora quando um limite é atingido.

Para configurar alertas de webhook de saída:

1. Em Alert configuration (Configuração de alerta), ative os alertas que você quer receber:
   • Alerta de nova tentativa
     Defina um limite para receber uma notificação quando o número de eventos de webhook de saída em nova tentativa atingir esse valor. O limite mínimo é 50.
   • Fail alert (Alerta de falha)
     Defina um limite para receber uma notificação quando o número de eventos de webhook de saída com falha atingir esse valor. O limite mínimo é 50.
     
2. Clique em Save (Salvar).

Desativar um webhook de saída

Se precisar parar temporariamente de enviar dados da Brevo para seu aplicativo externo, você poderá desativar o webhook de saída.

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 webhookde saída .
4. Desative o webhook de entrada que você deseja desativar.
    

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

excluir um webhookde saída

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

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

O webhook de saída foi excluído permanentemente.

🤔 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.