Usar webhooks da ActiveCampaign

Marketing_Lite_Plus_Professional_Enterprise

Sales_Plus_Professional_Enterprise

Com a ActiveCampaign, você pode usar webhooks para enviar atualizações em tempo real sobre seu contato e atividade de campanha para uma fonte externa.

Tome nota

  • Ao criar um webhook, o app de recebimento deve aceitar solicitações POST e ter uma API. Além disso, suportamos apenas o envio de solicitações HTTPS para a porta HTTPS padrão (porta 443)
  • a ActiveCampaign não aceita webhooks de entrada
  • As cargas úteis do Webhook não podem ser personalizadas. A especificação de autorização é limitada aos parâmetros de URL e URL

O que é um webhook?

Webhooks são mensagens automatizadas enviadas de um sistema para outro quando ocorre um evento especificado. Você pode usar webhooks para enviar dados de sua conta da ActiveCampaign para atualizar um banco de dados ou app externo com atividades de contato, campanha, negócio e objeto personalizado à medida que elas acontecem.

Por exemplo, talvez você queira criar um webhook para enviar dados a um banco de dados externo sempre que um registro de contato for atualizado, quando uma conta for adicionada, quando uma tarefa do negócio for criada ou quando um contato clicar em um link em seu email. 

Existem dois tipos de webhook: Standard e Custom Object. A disponibilidade desses tipos de webhook depende do tipo de plano que você tem. Por exemplo, algumas contas podem ter acesso a ambos os tipos, enquanto outras terão apenas webhooks padrão.

Tipos de Webhook

a ActiveCampaign oferece dois tipos de webhooks: Objeto Padrão e Objeto Personalizado.

Webhooks de objeto padrão

A disponibilidade de alguns objetos padrão depende do seu plano ActiveCampaign

Você pode usar webhooks padrão para postar dados em uma fonte de terceiros quando uma ação ocorrer.

Os webhooks de objeto padrão incluem Contatos, Negócios, Contas, Campanhas, Site e eventos de SMS. 

Aqui está uma lista das ações disponíveis para acionar um webhook padrão:

  • Conta - adicionada ou atualizada
  • Campanha - encaminhada, aberta, compartilhada, começa a enviar
  • Contato - adicionado ou atualizado ao seu ActiveCampaign, adicionado, atualizado ou removido em uma Conta no seu ActiveCampaign, nota adicionada, tag adicionada ou removida, tarefa adicionada, cancelada
  • Negócio - adicionado ou atualizado, nota adicionada, funil adicionado, etapa adicionado, tarefa adicionada ou concluída, tipo de tarefa adicionado
  • email - devolvido, respondido
  • Link - clicado
  • Lista - adicionado
  • SMS - respondido, enviado, cancelado

Webhooks de objetos personalizados

Disponível nos planos Marketing Enterprise e Sales Enterprise.

Use webhooks de objeto personalizado para postar dados em uma fonte de terceiros quando ocorrer uma ação com um objeto personalizado. Isso inclui objetos personalizados importados de uma integração de terceiros com suporte e objetos personalizados criados usando a API ou a página "Gerenciar dados" em sua conta.

Para usuários do Shopify e do WooCommerce, webhooks de objeto personalizados estão disponíveis para:

  • Pedidos: criados, atualizados, excluídos
  • Produtos: criados, atualizados, excluídos

Onde webhooks são criados

Há dois locais onde você pode criar um webhook na ActiveCampaign: Configurações do desenvolvedor e Automação. 

Configurações de desenvolvedor em Minhas configurações

Lançará dados em uma fonte de terceiros sempre que uma ação/evento especificado for concluído.

Ação de automação do webhook

Lançará dados em outro URL assim que um contato interagir com a ação Webhook em uma automação.

Essa ação só funciona com webhooks de objeto padrão.

Você não precisa criar um webhook em "Configurações de desenvolvedor" para disparar um webhook de uma automação. 

href="https://help.activecampaign.com/hc/pt-br/articles/115000161204" target="_blank" rel="noopener">enviar um webhook de uma automação

Opções de iniciação do Webhook

Abaixo estão as opções de iniciação do webhook:

  • Iniciado por um contato: Esta opção executa ganchos quando um contato causa a ação. Por exemplo, quando um contato abre uma campanha
  • Iniciado por qualquer usuário: Execute os ganchos quando um administrador na conta causar a ação. Por exemplo, quando um contato é adicionado da área administrativa
  • Iniciados por processos do sistema: Neste caso, execute os ganchos quando os sistemas automatizados executam a ação. Um exemplo seria quando um email é devolvido
  • Iniciado pela API: Execute os ganchos quando a chamada API causar a ação. Por exemplo, ao adicionar um contato usando a chamada de API contact_add

Criar um webhook em Configurações do desenvolvedor

Disponível nos planos de Marketing e Vendas.

Com essa configuração, você pode escolher qual tipo de webhook criar. 

  1. Clique em "Configurações" no menu à esquerda.
  2. Clique no botão "Gerenciar webhooks".
  3. Clique no botão "Adicionar".
  4. Uma janela modal aparecerá. Escolha o tipo de webhook que deseja criar.
  5. Na próxima tela, preencha os campos para criar seu webhook:
    • Webhooks de objeto padrão:
      • Preencha os campos nome e URL. O campo URL é onde o webhook será postado quando a ação ocorrer
      • Na lista suspensa "Tipo", selecione a ação ou evento que acionará a execução do webhook. Você pode selecionar vários eventos
      • Selecione de onde a(s) ação(ões) deve (m) ser inicializada(s). Por exemplo, você pode escolher se o webhook deve ser acionado a partir da ação de um contato ou de um usuário da conta
      • Selecione a lista à qual o webhook deve ser associado. Este campo de lista só aparecerá se o tipo de webhook exigir uma lista
      • Clique no botão "Salvar"
    • Apps e webhooks personalizados:
      • Forneça um nome para seu webhook
      • Clique no menu suspenso "Tipo" para selecionar a ação ou evento que acionará a execução do webhook. Você pode selecionar vários eventos
      • Forneça o URL na qual o webhook deve postar
      • Clique no botão "Salvar"
    • Webhooks de objeto personalizado de ecommerce:
      • Forneça o nome do seu webhook
      • Forneça a URL para a qual o webhook deve postar
      • Clique no menu suspenso "Tipo" para selecionar a ação ou evento que acionará a execução do webhook. Você pode selecionar vários eventos
      • Clique no botão "Salvar"

Como os dados do webhook são recebidos

Os dados que você receber serão enviados como um parâmetro POST para seu URL. Visualizar uma lista de campos que serão enviados em seu webhook. 

Se você usar a ação de automação do webhook, poderá encontrar os dados específicos enviados aqui.

A ActiveCampaign garante a entrega de webhooks pelo menos uma vez. Isso significa que às vezes podemos enviar um webhook mais de uma vez para um único evento.

Caracteres e limites válidos para webhooks

Você pode usar caracteres alfanuméricos, além dos seguintes caracteres especiais no URL do webhook:
"$-_.+!*' (),"

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

Como testar seu webhook

Para testar seu webhook, clique no botão "Enviar dados de exemplo" localizado na página Configurações > Desenvolvedor > Webhooks em sua conta da ActiveCampaign. Depois de clicados, enviaremos os dados de teste para o URL especificado na barra de URL do webhook.

Esse artigo foi útil?
Usuários que acharam isso útil: 9 de 33