Se você está familiarizado com as métricas detalhadas que a Brevo oferece para e-mails, sabe como pode ser complicado tentar entender tudo isso. Em vez de vasculhar um palheiro de dados para encontrar as informações que você precisa, os webhooks permitem que você receba os dados certos diretamente, permitindo que você acesse os detalhes importantes de que precisa sem complicações.
O que é um webhook?
Webhooks podem ser definidos como notificações acionadas por eventos específicos. Eles são normalmente usados para facilitar a comunicação entre vários sistemas. Essencialmente, os webhooks fornecem um meio direto de receber alertas sempre que um evento ocorre em outro sistema.
Em termos mais técnicos, um webhook é um retorno de chamada HTTP que permite que vários sistemas se interconectem e mantenham ações consistentes entre eles. Quando ocorre um evento em um sistema, uma solicitação POST é enviada para o URL fornecido em tempo real. Essa solicitação HTTP POST contém informações relacionadas a esse evento específico, por exemplo, a hora em que ocorreu, o nome do evento e os principais identificadores.
Como funcionam os webhooks na Brevo?
Na Brevo, um webhook é um URL que você pode integrar em nosso sistema para receber atualizações em tempo real sobre eventos relacionados ao envio de seus e-mails de marketing e transacionais e ao gerenciamento de seus contatos. Com webhooks, você pode rastrear eventos específicos de seu interesse, como quando um e-mail foi aberto ou um contato foi excluído.
Existem vários tipos de eventos que você pode rastrear. Por exemplo, você pode receber notificações sobre o status de sua campanha de marketing em andamento e saber como está o desempenho dela em tempo real. Você também pode acompanhar quando suas mensagens transacionais estão sendo enviadas, entregues ou abertas pelos destinatários. Ou você também pode ser notificado sobre alterações em seus contatos.
Quais eventos estão disponíveis na Brevo?
Todos os eventos disponíveis que você pode rastrear na Brevo estão agrupados em duas categorias:
| Quando um e-mail é: | Quando um contato é: |
|
|
Você pode encontrar mais informações sobre eventos de marketing e os dados associados na documentação da API.
| Quando um e-mail é: | |
|
|
Você pode encontrar mais informações sobre eventos transacionais e os dados associados na documentação da API.
Crie seu webhook
Para nossos exemplos, focaremos no evento “Aberto” da plataforma transacional. Basicamente, sempre que enviarmos um novo e-mail transacional, receberemos uma notificação através do nosso webhook indicando que o e-mail chegou com sucesso à caixa de entrada do destinatário.
-
Vá para a página Webhooks:
- Para eventos de marketing, acesse Contacts > Settings > Webhooks (Contatos > Configurações > Webhooks) ou Campaigns > Settings > Webhooks (Campanhas > Configurações > Webhooks).
- Para eventos transacionais, acesse Transactional (Transacional) > Settings (Configurações) > Webhooks.
- Clique em Add a new webhook (Adicionar um novo webhook).
- No campo URL, insira o URL de notificação onde os dados do evento serão enviados sempre que o evento for acionado.
- Nos campos When the message is (Quando a mensagem for) ou When the contact is (Quando o contato for), selecione os eventos dos quais deseja receber notificações.
- No campo Description (Descrição), insira uma descrição para o webhook.
- Quando terminar, clique em Save (Salvar).
- Depois de criar seu webhook, recomendamos que você o teste. Ao lado do webhook que você criou, clique em Actions (Ações) > Send a test (Enviar um teste) ou Test (Teste). Assim que o evento for acionado, você receberá uma notificação no URL especificado para o webhook.
Ao criar um webhook a partir de uma automação, você receberá uma notificação sempre que um contato atingir a etapa Call a webhook (Chamar um webhook) em sua automação.
- Vá para Automations (Automações).
- Clique em Create an automation (Criar uma automação).
- Use uma automação predefinida ou crie uma personalizada.
- Adicione um ponto de entrada à sua automação.
- (Opcional) Adicione as etapas que seus contatos precisam seguir antes de acionar seu webhook.
- Adicione a etapa Call a webhook (Chamar um webhook) à sua automação:
- Na última etapa da sua automação, clique em +.
- Selecione a etapa Call a webhook (Chamar um webhook).
- No campo Enter the URL (Insira o URL), insira o URL de notificação onde os dados do evento serão enviados sempre que o evento for acionado.
- (Opcional) Para receber informações sobre o contato que acionou o evento, habilite a opção I want to send contact properties to the webhook (Desejo enviar propriedades do contato para o webhook).
- Clique em OK.
- (Opcional) Adicione etapas adicionais à sua automação.
- Teste sua automação para ter certeza de receber as informações.
- Clique em Activate the automation (Ativar a automação) para permitir que seus contatos entrem na automação.
Para criar um webhook a partir da API, basta fazer uma chamada simples para configurar o URL do webhook que deseja usar. Aqui está um exemplo de chamada:
| curl --request POST \ --url https://api.brevo.com/v3/webhooks \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "url": "http://requestb.in/173lyyx1", "description": "Webhook triggered on opened emails", "events": [ "opened" ], "type": "transactional", "domain": "example.com" } ' |
Para saber mais sobre como criar webhooks a partir da API, consulte a documentação da API.
Proteja seu webhook
Depois de criar e testar seu webhook, recomendamos que você o proteja para garantir que não fique acessível a outras pessoas na web. Para proteger seus webhooks, você precisa colocar na lista de permissões os seguintes intervalos de IP Brevo:
-
1.179.112.0/20-
Primeiro endereço IP:
1.179.112.1 -
Último endereço IP:
1.179.127.254
-
Primeiro endereço IP:
🤔 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 o parceiro especialista certificado em Brevo.