Trabalhando com webhooks

Um webhook é uma maneira leve de um aplicativo passar informações para outros aplicativos quase em tempo real. Isso pode significar notificar um aplicativo particular desenvolvido apenas para você ou uma maneira de notificar outro aplicativo de terceiros que aceita solicitações POST.

Na ActiveCampaign, os webhooks são usados ​​para enviar dados de sua conta para outro sistema ou banco de dados que possui uma API (application programming interface) que pode procurar ouvir webhooks (por exemplo, Zapier). Eles são orientados a eventos e permitem que você atualize aplicativos de terceiros com atividades de contato e de campanha à medida que acontecem.

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.

Você pode querer usar webhooks para manter registros de inscritos em sincronia com um banco de dados ou aplicativo externo, manter uma lista de devolução ou cancelamento de inscrição externa ou registrar aberturas, cliques, encaminhamentos e compartilhamentos de campanhas para enviar a outro aplicativo, para suas necessidades de relatórios personalizados.

Neste artigo, discutiremos o seguinte:

Onde webhooks são criados

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

  • Configurações do desenvolvedor em "Minhas configurações": disparará toda vez que uma ação/evento especifico for concluído.
  • Ação de automação de Webhook: disparará somente quando um contato concluir a etapa de ação de automação de webhook. Para mais informações sobre como enviar um webhook de uma automação, consulte este documento de ajuda.

É importante observar que você não precisa criar um webhook nas configurações do desenvolvedor para disparar um webhook de uma automação.

Como criar um webhook: configurações do desenvolvedor

Com cada webhook que você cria, você pode escolher quando deve disparar. Por exemplo, você pode querer receber dados apenas quando um contato abrir um e-mail, ou querer receber dados apenas quando um contato é adicionado via API.

Para começar, clique no seu avatar e selecione "Minhas configurações".

Account_my_settings.png

Selecione "Desenvolvedor" no menu do lado esquerdo e clique em "Gerenciar Webhooks".

Developer_manage_webhooks.png

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

Click_add_for_webhook.png

Selecione a lista à qual o seu webhook será associado selecionando-o no menu suspenso, ou selecione "Todas as listas".

Em seguida, digite o nome do seu webhook no campo Nome e digite o URL da sua integração ou aplicativo para o qual deseja enviar informações. Essa URL precisará vir de seu aplicativo ou integração de terceiros.

Webhook_example_1.png

Em seguida, marque as caixas ao lado de qualquer ação/evento que acione seu webhook:

  • Campanha encaminhada (por meio do link de encaminhamento da ActiveCampaign)
  • Campanha aberta
  • Campanha compartilhada (para o Facebook ou Twitter)
  • Campanha começa a ser enviada
  • 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 da negócio adicionada
  • Pipeline de negócio adicionado
  • Estágio de negócio adicionado
  • Tarefa de negócio adicionada
  • Tarefa de negócio concluída
  • Tipo de tarefa de negócio adicionada
  • Negócio atualizado
  • E-mails devolvidos
  • Respostas por e-mail
  • Link clicado
  • Lista adicionada
  • Resposta de SMS
  • SMS enviado
  • Cancelamento de inscrição de SMS

webhook_type_1.png

Em seguida, marque as caixas ao lado de qualquer fonte que acione seu webhook:

  • Ação de contato - é executada quando um contato causa a ação (por exemplo, inscreve-se, abre uma campanha, etc.)
  • Ação do usuário administrador - é executada quando um usuário administrador faz a ação (por exemplo, adiciona um contato da área administrativa)
  • API - Executa quando a chamada da API faz com que a ação (por exemplo, adiciona um contato usando a chamada da API contact_add)
  • Processos do sistema - são executados quando o sistema automatizado causa a ação (por exemplo, rejeições, e-mails de automação, etc.)

webhook_initialize_from.png

Quando terminar, clique em "Adicionar" no canto inferior esquerdo da tela.

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

final_webhook_example.png

Como os dados do webhook são recebidos

Os dados que você recebe serão enviados como um parâmetro POST para sua URL. Para visualizar 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 e os seguintes caracteres especiais em sua 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.

Testando seu webhook

Para testar seu webhook, basta clicar em "Enviar dados de amostra" na página do webhook, e enviaremos dados de teste para a URL especificada na barra de URL do webhook.

test_webhook.png

Resolução de problemas do seu webhook

Se o seu webhook não estiver funcionando, recomendamos que você teste sua URL usando um serviço como o Request Catcher para garantir que ele seja responsivo e receba solicitações de POST.

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

Se você achar que a URL está respondendo e ainda assim não está recebendo informações, envie uma solicitação de suporte ou abra um bate-papo ao vivo com um de nossos agentes.

Saiba mais sobre o uso de webhooks

Para aprender como enviar um webhook de uma automação, clique aqui.
Para saber como usar um webhook para atualizar uma planilha do Google com informações de contato via Zapier para questões de relatórios personalizados, clique aqui.
Para aprender a inserir o valor de um campo personalizado em outro usando o Zapier e um webhook em uma automação, clique aqui.

Tem mais dúvidas? Envie uma solicitação