O envio de webhooks de saída de uma automação permite que você envie uma notificação em tempo real com dados de eventos do Brevo para um aplicativo externo quando um contato atinge a etapa Chamar um webhook.
Este artigo explica como enviar webhooks de saída de uma automação. Você também pode criar webhooks de saída configurando-os diretamente em sua conta Brevo ou a partir da API.
Antes de começar
No aplicativo externo, recupere a URL do servidor ou do ponto de extremidade para o qual deseja enviar o webhook de saída. Caso não tenha certeza de onde recuperá-lo, verifique a central de ajuda do seu aplicativo externo ou entre em contato com a equipe de suporte.
Enviar webhooks de saída de uma automação
Para enviar webhooks de saída de uma automação, você precisa adicionar a etapa Chamar um webhook e configurá-la com a URL do seu webhook e os detalhes de autenticação.
Use as seguintes guias para visualizar instruções para o editor de automação novo ou clássico:
- Em uma automação criada usando o novo editor, adicione a etapa Call a webhook (Chamar um webhook).
- 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.
- Selecione um método de autenticação no menu suspenso:
- Sem autenticação: O webhook será enviado sem credenciais de autenticação.
- Básico: Insira seu nome de usuário e senha. A Brevo vai codificar essas credenciais e enviá-las com cada solicitação de webhook.
- Token: Insira seu token de autenticação. A Brevo enviará este token em cada solicitação de webhook.
-
(Opcional) Clique em Adicionar objeto para adicionar cabeçalhos personalizados à sua solicitação de webhook. Insira o nome e o valor do cabeçalho. Você pode adicionar vários cabeçalhos, se necessário.
💡 É bom saberOs cabeçalhos personalizados são úteis para autenticação ou para transmitir metadados adicionais para seu app externo. - (Opcional) Na seção Configurações adicionais, configure quais dados serão incluídos no webhook:
- Include details of the contact who triggered the event (Incluir detalhes do contato que acionou o evento): quando ativado, o Brevo inclui todos os atributos do contato no webhook. Por padrão, apenas o ID do contato, e-mail, ID da etapa e ID do cenário são incluídos.
- Include details of the trigger event (Incluir detalhes do evento de gatilho): Quando ativado, o Brevo inclui os dados do evento da carga útil no webhook.
- Clique em Save (Salvar) para salvar a etapa.
- Finalize as configurações da sua automação e ative-a.
- Em uma automação criada usando o editor clássico, adicione um ponto de entrada.
- (Opcional) Adicione as etapas pelas quais você deseja que seus contatos passem antes de ativar o webhook.
- Adicione a etapa Call a webhook (Chamar um webhook) à sua automação:
- Na tela, clique em + onde você deseja adicionar a etapa Call a webhook (Chamar um webhook).
- Selecione a etapa Call a webhook (Chamar um webhook).
-
Cole a URL do webhook fornecida pelo seu aplicativo externo. Esse URL de retorno informa ao Brevo para onde enviar os dados quando um evento acontece.
💡 É bom saberA URL do webhook deve ser gerada e recuperada do seu aplicativo externo. Caso não tenha certeza de onde recuperá-lo, verifique a central de ajuda do seu aplicativo externo ou entre em contato com a equipe de suporte. - (Opcional) Ative a opção I want to send contact properties to the webhook (Quero enviar propriedades de contato para o webhook) para incluir propriedades de contato no webhook.
- Clique em OK.
- Finalize as configurações da sua automação e ative-a.
Proteger webhooks de saída
Para proteger seus webhooks de saída, coloque 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 Intervalos de IP da Brevo: lista de serviços expostos publicamente.
⏭️ O que vem a seguir?
- Crie webhooks de saída para enviar dados em tempo real do Brevo para um aplicativo externo
- Crie um webhook de entrada para receber dados em tempo real de outro aplicativo no Brevo
🤔 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.