Ir para o conteúdo principal
Isenção de responsabilidade de tradução: esse conteúdo foi traduzido para sua conveniência com o uso de software e pode não ter sido revisado por uma pessoa. O texto oficial é a versão em inglês e sempre será o texto mais atualizado. Para ver a versão em inglês, clique aqui.

Usar webhooks com fluxos de trabalho do HubSpot

Ultima atualização: Fevereiro 21, 2024

Disponível com qualquer uma das seguintes assinaturas, salvo menção ao contrário:

Operations Hub Professional, Enterprise

Use webhooks nos fluxos de trabalho para enviar ou recuperar informações entre a HubSpot e outras ferramentas externas. Há uma variedade de usos para webhooks. Exemplos de casos de uso populares para eles incluem:

  • A publicação dos dados de contatos da HubSpot em outro sistema, como um CRM, quando esse contato preencher um formulário específico no seu site.

  • O envio de dados do negócio para um sistema de tratamento de envio externo para criar um pedido de compra.

  • O envio de alertas de chat do seu sistema externo para o fluxo de chat da sua empresa, para notificar os funcionários de que algo importante aconteceu.

  • A recuperação de dados de outro sistema para atualizar seus registros do HubSpot. 

Você pode enviar solicitações POST e GET usando fluxos de trabalho. O HubSpot regula o tráfego de webhook separadamente de outros processos de fluxo de trabalho. Isso é feito para simplificar o fluxo de trabalho e o desempenho do webhook. Quando um webhook estiver lento ou expirado, a ação do fluxo de trabalho poderá demorar mais do que o esperado para ser executada.

Observação: o HubSpot tentará novamente os webhooks com falha por até três dias, começando um minuto após a falha. As falhas subsequentes serão tentadas novamente em intervalos crescentes, com uma lacuna máxima de oito horas entre as tentativas. Os fluxos de trabalho não voltam a tentar depois de receberem códigos de estado de resposta da série 4XX.
Uma exceção a esta regra são os erros de limite de taxa 429; os fluxos de trabalho voltam a tentar automaticamente depois de receberem uma resposta 429 e respeitam o cabeçalho Retry-After, se presente. A opção "Retry-After" é registada em milissegundos. Saiba sobre as exceções de código de erro específicas na Documentação para desenvolvedores da HubSpot.

Saiba mais sobre webhooks na documentação para desenvolvedores sobre webhooks. Se você tiver dúvidas sobre sua implementação específica de webhooks com o HubSpot, entre em contato com o HubSpot Developers Forums.

Configurar um webhook no seu fluxo de trabalho

  • Na sua conta da HubSpot, navegue até Automação > Fluxos de trabalho.
  • Clique no nome do fluxo de trabalho.
  • Clique no ícone de + para adicionar uma ação.
  • No painel esquerdo, seleccione Enviar um webhook.
  • Clique no menu suspenso Método e selecione POST ou GET
  • Digite o URL do webhook. As URLs de webhook estão restritas a um protocolo seguro e devem começar com HTTPS. Para solicitar informações específicas, você pode adicionar parâmetros de consulta como ?queryparameter=abc ao URL do webhook. Se nenhum parâmetro de consulta tiver sido adicionado, uma solicitação genérica POST ou GET será enviada. 
  • Configure seu tipo de autenticação para autenticar solicitações ao webhook: 
    • Para usar uma assinatura de solicitação no cabeçalho do webhook: 
      • Clique no menu suspenso Tipo de autenticação. Selecione Incluir assinatura de solicitação no cabeçalho.
      • Digite o ID do aplicativo HubSpot. Saiba como verificar assinaturas de solicitação.
    • Você também pode usar uma chave de API ou um aplicativo público criado por meio de uma conta de desenvolvedor para autenticação.

Observação: a partir de 30 de novembro de 2022, as chaves de API da HubSpot serão desativadas e não terão mais suporte. Você ainda pode utilizar as chaves de API externas para autenticação nos fluxos de trabalho do HubSpot.

      • Ao utilizar uma chave de API para autenticação, o nome da chave de API e a localização da chave API usada dependerão de como o webhook foi configurado. Por motivos de segurança, a chave de API não será exibida em nenhuma solicitação de teste. Para utilizar uma chave de API: 
        • Clique no menu suspenso Tipo de autenticação. Selecione a chave de API
        • Insira o nome da chave de API.
        • Clique no menu suspenso Localização da chave de API. Em seguida, selecione Parâmetros de consulta ou Cabeçalho da solicitação. Saiba mais sobre como usar as chaves de API no HubSpot.
      • Ao fazer uma solicitação a uma de nossas APIs da HubSpot:
        • Clique no menu suspenso chave de API e selecione um segredo. O valor do segredo deve estar no formato Titular [YOUR_TOKEN].
        • Defina o valor do nome da chave de API para Autorização.
        • Defina o valor da localização da chave de API para Cabeçalho da solicitação.
  • Ao configurar uma solicitação POST, você pode optar por incluir todas as propriedades do registo do CRM ou enviar apenas propriedades específicas:
    • Para incluir todas as propriedades, na seção Personalizar corpo da solicitação, selecione Incluir todas as propriedades
    • Para incluir apenas propriedades específicas:
      • Na seção Personalizar corpo da solicitação, selecione Escolher propriedades específicas.
      • Clique no menu suspenso Escolher propriedade. Em seguida, clique em [objeto] neste fluxo de trabalho e selecione uma propriedade.
      • Para alterar o nome de uma propriedade no webhook, edite o campo de texto Nome da propriedade. Isso apenas atualizará o nome da propriedade na solicitação POST, não atualizará o nome da propriedade nem o nome interno no HubSpot. 
      • Para adicionar outra propriedade, clique em Adicionar propriedade.
      • Para remover uma propriedade, clique no ícone de lixeira delete.
         


  • Ao configurar uma solicitação GET, você pode usar propriedades como parâmetros de consulta:
    • Na seção Parâmetros de consulta , clique no menu suspenso Escolher propriedade. Em seguida, clique em [objeto] neste fluxo de trabalho e selecione uma propriedade.
    • Para alterar o nome de uma propriedade no parâmetro de consulta, edite o campo de texto do nome da propriedade. Isso apenas atualizará o nome da propriedade na solicitação GET, não atualizará o nome da propriedade nem o nome interno no HubSpot. 
    • Para adicionar outra propriedade, clique em Adicionar parâmetro de consulta.
    • Para remover uma propriedade, clique no ícone de lixeira delete
  • Clique em Salvar.



Observação: para selecionar várias saídas, a resposta deve ser estruturada como um objeto JSON.

Personalize suas solicitações POST

Ao configurar uma solicitação POST, você pode optar por incluir todas as propriedades do registo do CRM ou enviar apenas propriedades específicas:

  • Para incluir todas as propriedades, na seção Personalizar corpo da solicitação, selecione Incluir todas as propriedades
  • Para incluir apenas propriedades específicas:
    • Na seção Corpo da solicitação, selecione Personalizar corpo da solicitação.
    • Insira a Chave e o Valor.
    • Para alterar o nome de uma propriedade no webhook, edite o campo de texto Chave. Isso apenas atualizará o nome da propriedade na solicitação POST, não atualizará o nome da propriedade nem o nome interno no HubSpot. 
    • Para adicionar outra propriedade, clique em Adicionar propriedade.
    • Para remover uma propriedade, clique no ícone de lixeira delete

send-post-webhook-request

Personalize suas solicitações GET

Ao configurar uma solicitação GET, você pode usar propriedades como parâmetros de consulta para recuperar dados específicos: 

  • Na seção Parâmetros de consulta , insira a Chave e selecione uma propriedade.
  • Para alterar o nome de uma propriedade no parâmetro de consulta, edite o campo de texto do nome da propriedade. Isso apenas atualizará o nome da propriedade na solicitação GET, não atualizará o nome da propriedade nem o nome interno no HubSpot. 
  • Para adicionar outra propriedade, clique em Adicionar propriedade.
  • Para remover uma propriedade, clique no ícone de lixeira delete
  • Selecione um Tipo de autenticação no menu suspenso.
  • Clique em Salvar.

send-webhook-get-method

Testar seu webhook no HubSpot

Ao configurar seu webhook POST ou GET, você pode executar um teste para ver a resposta do webhook. Durante o teste, mesmo que dados sejam enviados e recuperados de um terceiro, os registros existentes no HubSpot não são afetados. Ao usar uma chave de API para autenticação, ela não será exibida em nenhuma solicitação de teste.

Depois de testar seu webhook, você pode selecionar os campos que devem ser apresentados como entradas no seu fluxo de trabalho posteriormente. Selecione somente as saídas disponíveis em cada resposta. Se a saída for utilizada em uma ação posterior, mas não estiver disponível na resposta, a ação irá falhar. 

  • No painel lateral, clique em Testar ação para expandir a seção. 
  • Clique no menu suspenso Objeto e selecione um Registro para testar.
  • Clique em Testar
  • Para verificar os detalhes do webhook, selecione a guia Resposta ou Solicitação. Em cada guia, você pode clicar em Abrir tudo para expandir todas as seções, ou Recolher tudo para recolher todas as seções.
    • Na guia Resposta, clique em cabeçalhos: ou corpo: para expandir cada seção. 
    • Na guia Solicitação, clique em httpHeaders: para expandir a seção.

Testar seu webhook externamente

Depois de criar seu fluxo de trabalho com uma ação de webhook, você poderá executar um teste rápido com uma URL fictícia de webhook.

  • No navegador, acesse https://webhook.site e copie a URL exclusiva.
  • No campo de Webhook URL em sua ação de webhook, cole a URL.

Se uma ação do webhook for disparada com uma solicitação POST, um corpo de resposta JSON será enviado ao webhook com todas as informações sobre o contato, incluindo os envios de formulários, membros da lista e todos os valores da propriedade do contato. O sistema de recebimento pode, então, analisar os dados JSON e usá-los para seu próprio aplicativo.

Se uma ação do webhook for disparada com uma solicitação GET, uma solicitação genérica GET será enviada, a menos que parâmetros adicionais de consulta tenham sido aplicados. 

Observação: os valores de propriedade antigos serão devolvidos apenas em fluxos de trabalho baseados em contato. Os webhooks usados em todos os outros tipos de fluxo de trabalho retornarão o valor mais recente.

Verificar assinaturas de solicitação em webhooks de fluxo de trabalho

Quando você selecionou Solicitar assinatura na seção Autenticação da ação Acionar um webhook, o HubSpot preencherá o webhook com um cabeçalho X-HubSpot-Signature com um hash SHA-256 da concatenação do aplicativo-segredo para o seu aplicativo, o método HTTP, o URI e o corpo não analisado. Saiba mais sobre isso na documentação para desenvolvedores.

Para verificar se as solicitações recebidas no seu URL são do HubSpot:

Disparar fluxos de trabalho a partir de webhooks

Os webhooks podem ser usados para disparar fluxos de trabalho. Quando os dados são alterados em um aplicativo de terceiros, isso pode disparar um fluxo de trabalho. Saiba mais sobre como disparar fluxos de trabalho a partir de webhooks.

Utilizar dados do webhook no painel de dados

Os dados do webhook ligado à sua conta podem ser utilizados para determinadas acções no painel de dados .

Para utilizar os dados do webhook ligado a :

  • Na sua conta da HubSpot, navegue até Automação > Fluxos de trabalho.
  • Clique no nome do fluxo de trabalho.
  • Clique no ícone + plus para adicionar uma ação.
  • No painel esquerdo, seleccione uma ação que utilize o painel de dados .
  • No painel de dados, em Propriedades de registo, pode selecionar uma das propriedades do webhook ligado.
enrollment-properties-webhooks
Esse artigo foi útil?
Este formulário deve ser usado apenas para fazer comentários sobre esses artigos. Saiba como obter ajuda para usar a HubSpot.