Como trabalhar com webhooks

Um webhook permite que um app passe informações para outros aplicativos em quase tempo real. Isso pode significar notificar um aplicativo privado desenvolvido apenas para você, ou uma maneira de notificar outro aplicativo de terceiros que aceite solicitações POST.

Na ActiveCampaign, webhooks são usados para enviar dados de sua conta para outro sistema ou banco de dados que tenha uma API (interface de programação de aplicativos) que pode ouvir webhooks (por exemplo, Zapier). Eles são impulsionados por eventos e permitem que você atualize aplicativos de terceiros com atividades de contato e campanha à medida que acontecem.

Você pode querer usar webhooks para manter os registros de inscritos em sincronia com um banco de dados ou aplicativo externo, manter uma lista externa de cancelamento ou rejeição ou capturar campanhas abertas, cliques, encaminhamentos e ações para encaminhar para outro aplicativo para suas próprias necessidades de geração de relatórios personalizados.

A ActiveCampaign não aceita webhooks recebidos. Em vez disso, você precisará usar nossa API para enviar informações para sua conta a partir de um aplicativo de terceiros.

Neste artigo:

Onde webhooks são criados

Existem dois lugares diferentes onde você pode configurar um webhook:

  • Configurações de desenvolvedor em Minhas configurações
    Será acionado toda vez que uma ação especificada ou evento for concluído
  • Ação de automação do webhook
    Será acionado somente quando um contato completar a etapa de ação de automação de webhook. Você não precisa criar um webhook em "Configurações de desenvolvedor" para disparar um webhook de uma automação. Saiba mais sobre como enviar um webhook a partir de uma automação

Como criar um webhook

A cada webhook que criar, você pode escolher quando ele deve disparar. Por exemplo, você pode desejar receber dados apenas quando um contato abre um e-mail ou quando um contato é adicionado via API.

Nesta seção, você saberá como criar um webhook a partir da página de configurações "Desenvolvedor". 

1. Clique em “Configurações” no menu esquerdo, em seguida clique em “Desenvolvedor”.  

2. Na página Configurações de desenvolvedor, clique em "Gerenciar webhooks".

3. Você será redirecionado para a página de webhooks. Clique em “Adicionar” para criar um webhook.

4. Selecione a qual lista seu webhook estará associado, clicando na lista da caixa de seleção, ou selecionando “Todas as listas”.

5. Digite o nome do seu webhook no campo Nome e digite a URL a partir de sua integração ou aplicativo para o qual você deseja enviar informações. Essa URL precisará vir do seu aplicativo ou integração de terceiros.

6. Clique nas caixas ao lado de qualquer ação/evento que acionará seu webhook:

  • Campanha encaminhada (por meio do link de encaminhamento da ActiveCampaign)
  • Campanha aberta
  • Campanha compartilhada (no Facebook ou Twitter)
  • Campanha começa a enviar
  • Contato adicionado
  • Nota de contato adicionada
  • Tag de contato adicionada
  • Tag de contato removida
  • Cancelamento de inscrição de contato
  • Contato atualizado
  • Negócio adicionado
  • Nota de negócio adicionada
  • Funil de negócio adicionado
  • Fase de negociação adicionada
  • Tarefa de negócio adicionada
  • Tarefa de negócio concluída
  • Tipo de tarefa de negócio adicionado
  • Negócio atualizado
  • Bounces de e-mail
  • Respostas por e-mail
  • Clique em link
  • Lista adicionada
  • Resposta por SMS
  • SMS enviado
  • Cancelamento de inscrição de SMS

7. Clique nas caixas ao lado de qualquer origem que acionará seu webhook:

  • Por um contato - Funciona quando um contato causa a ação (por exemplo, se inscreve, abre uma campanha etc.)
  • Por um usuário administrativo - Funciona quando um usuário administrativo causa a ação (por exemplo, adicionando um contato da área administrativa)
  • Pela API - É executado quando a chamada API causa a ação (por exemplo, adicionando um contato usando a chamada API contact_add)
  • Por processos do sistema - Funciona quando o sistema automatizado causa a ação (por exemplo, bounces, e-mails de automação etc.)

8. Quando concluído, clique em “Adicionar” no canto inferior esquerdo da tela.

Aqui está um exemplo de um webhook que criamos. Neste webhook, desejamos enviar informações para o Zapier (que atualizará outro aplicativo) cada vez que um contato em qualquer lista cancelar a inscrição de nossos e-mails:

Como os dados do webhook são recebidos

Os dados recebidos serão enviados como parâmetro POST para sua URL. Para ver uma lista de campos que serão enviados em seu webhook para cada ação listada acima, clique aqui.

Caracteres e limites válidos para webhooks

Você pode usar caracteres alfanuméricos, além dos seguintes caracteres especiais na URL do webhook:
“$-_.+!*’(),”

Não há limites de caracteres no número de caracteres incluídos em uma nota ou outro campo em um webhook.

Como testar seu webhook

Para testar seu webhook, clique em “Enviar dados de amostra” em sua página de webhook e enviaremos dados de teste para a URL especificada na sua barra de URL do webhook.

Solução de problemas do seu webhook

Se o seu webhook estiver funcionando, recomendamos testar sua URL usando um serviço como o Request Catcher para garantir que ele seja responsivo e possa receber solicitações POST.

Se houver um problema com a URL, recomendamos trabalhar com seu desenvolvedor ou seu aplicativo de terceiros para solucionar ainda mais problemas. Além disso, convidamos você a conferir nossos Fóruns da comunidade de desenvolvedores.

Caso a URL seja responsiva e você ainda não esteja recebendo informações, envie um tíquete de suporte ou abra um chat em tempo real com um de nossos agentes.

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 1

Have more questions? Submit a request

Experimente Grátis