Consulte os conectores compatíveis com a Application Integration.

Gatilho do HubSpot

O gatilho do HubSpot é um acionador de evento de conector que permite invocar uma integração com base nos eventos personalizados do HubSpot definidos na instância do HubSpot.

Antes de começar

Se você planeja criar ou configurar uma nova conexão para o gatilho do HubSpot, verifique se tem o seguinte papel do Identity and Access Management (IAM) no projeto:

  • Administrador de conectores (roles/connectors.admin)
  • Para informações sobre como conceder papéis, consulte Gerenciar acesso.

Conceda os seguintes papéis do IAM à conta de serviço que você quer usar para o gatilho do HubSpot:

  • Invocador do Application Integration (roles/integrations.integrationInvoker)
  • Para informações sobre como conceder papéis a uma conta de serviço, consulte Gerenciar o acesso a contas de serviço.

Tipos de evento compatíveis

Com as assinaturas de webhook, é possível selecionar quais eventos seu app receberia. Os seguintes tipos de assinatura são compatíveis:

  • deal.creation
  • deal.propertyChange
  • deal.deletion
  • contact.creation
  • contact.propertyChange
  • contact.deletion
Para ver uma lista completa de tipos de evento, consulte Assinaturas de webhook.

Adicionar o gatilho do HubSpot

Para adicionar um gatilho do HubSpot à sua integração, siga estas etapas:

  1. No console do Google Cloud, acesse a página Application Integration.

    Acessar o Application Integration

  2. No menu de navegação, clique em Integrações.

    A página Lista de integrações aparece listando todas as integrações disponíveis no projeto do Google Cloud.

  3. Selecione uma integração existente ou clique em Criar integração para criar uma nova.

    Se você estiver criando uma integração:

    1. Digite um nome e uma descrição no painel Create Integration.
    2. Selecione uma região para a integração.
    3. Selecione uma conta de serviço para a integração. Você pode mudar ou atualizar os detalhes da conta de serviço de uma integração a qualquer momento no painel Resumo da integração na barra de ferramentas.
    4. Clique em Criar.

    Isso abre a integração na página do editor de integração.

  4. Na barra de navegação do editor de integração, clique em Gatilhos para conferir a lista de gatilhos disponíveis.
  5. Clique e coloque o elemento de gatilho do HubSpot no editor de integração.
  6. Para configurar o gatilho do HubSpot, use uma conexão do HubSpot disponível nos Integration Connectors ou crie uma nova conexão usando a opção de criação de conexão inline.

Configurar o gatilho do HubSpot usando uma conexão atual

É possível configurar o gatilho do HubSpot usando uma conexão atual do HubSpot nos Integration Connectors. O acionador do HubSpot é um acionador de evento do conector. Portanto, só é possível usar uma conexão do HubSpot com a assinatura de eventos ativada para configurar o acionador.

Saiba como configurar um gatilho do HubSpot usando uma nova conexão do HubSpot em Configurar um gatilho do HubSpot usando uma nova conexão

Para configurar um gatilho do HubSpot usando uma conexão existente do HubSpot, siga estas etapas:

  1. Clique no elemento gatilho do HubSpot no editor de integração para abrir o painel de configuração do acionador.
  2. Clique em Configurar gatilho.
  3. Forneça os seguintes detalhes de configuração na página Editor do gatilho de evento do conector:
    1. Região:selecione a região da sua conexão do HubSpot.
    2. Conexão:selecione a conexão do HubSpot que você quer usar.

      A Application Integration exibe apenas as conexões do HubSpot que estão ativas e com uma assinatura de eventos ativada.

    3. Tipo de evento:selecione o tipo de evento que você quer usar para acionar a integração. Para ver uma lista dos tipos de evento aceitos, consulte Tipos de evento compatíveis.
    4. Conta de serviço: selecione uma conta de serviço com os papéis do IAM necessários para o gatilho do HubSpot.
  4. Clique em Concluído para finalizar a configuração do acionador e fechar a página.

Configurar o gatilho do HubSpot usando uma nova conexão

Para configurar o gatilho do HubSpot usando uma nova conexão do HubSpot, siga estas etapas:

  1. Clique no elemento gatilho do HubSpot no editor de integração para abrir o painel de configuração do acionador.
  2. Clique em Configurar gatilho.
  3. Ignore o campo Região.
  4. Clique em Conexão e selecione a opção Criar conexão no menu suspenso.
  5. Siga estas etapas no painel Criar conexão:
    1. Na etapa Local, escolha o local da nova conexão do HubSpot:
      1. Região:selecione uma região na lista suspensa.
      2. Clique em Próxima.
    2. Na seção Detalhes da conexão, faça o seguinte:
      1. Conector: selecione HubSpot na lista suspensa de conectores disponíveis.
      2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
      3. No campo Nome da conexão, insira um nome para a instância de conexão

        Os nomes de conexão precisam atender aos seguintes critérios:

        • Os nomes de conexões podem usar letras, números ou hifens.
        • As letras precisam ser minúsculas.
        • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
        • Os nomes das conexões não podem exceder 63 caracteres.
      4. Como opção, insira uma Descrição para a instância de conexão.
      5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
      6. Para usar a conexão em inscrições em eventos, selecione Ativar inscrição em eventos. Ao selecionar essa opção, aparecem as seguintes opções:
        • Ativar inscrição de eventos com entidade e ações: selecione essa opção para usar a conexão na inscrição de eventos e nas operações do conector (entidades e ações).
        • Ativar somente assinatura de eventos: selecione essa opção para usar a conexão apenas para a assinatura de eventos.

        Para essas duas seleções, você vai precisar configurar os detalhes do evento nas próximas etapas.

      7. Esquema: especifique a versão da API HubSpot a ser usada. HubSpotV4 é a nova API.
      8. BrowsableSchemas: essa propriedade restringe os esquemas informados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
      9. Contacts Properties: insira os nomes de campos separados por vírgula da entidade Contacts que você quer selecionar na operação de entidade List. Por exemplo: fieldA, fieldB, fieldC.
      10. Propriedades de empresas: insira os nomes de campos separados por vírgula da entidade Companies que você quer selecionar da operação de entidade List. Por exemplo: fieldA, fieldB, fieldC.
      11. Deals Properties: insira os nomes dos campos separados por vírgula da entidade Deals que você quer selecionar da operação de entidade List. Por exemplo: fieldA, fieldB, fieldC.
      12. Usar proxy: marque essa caixa de seleção para configurar um servidor proxy para a conexão.
      13. Esquema de autenticação de proxy: o tipo de autenticação a ser usado para autenticar o proxy do ProxyServer.
      14. Usuário do proxy: um nome de usuário a ser usado para autenticação no proxy do ProxyServer.
      15. Senha de proxy: senha a ser usada para autenticação no proxy do ProxyServer.
      16. Tipo de SSL do proxy: o tipo de SSL a ser usado na conexão com o proxy do ProxyServer.
      17. Opcionalmente, defina as Configurações do nó de conexão:

        • Número mínimo de nós: digite o número mínimo de nós de conexão.
        • Número máximo de nós: digite o número máximo de nós de conexão.

        Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

      18. Também é possível clicar em + Adicionar rótulo para incluir um rótulo na conexão na forma de um par de chave-valor.
      19. Clique em Próxima.
    3. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
      1. Tipo de destino: é possível especificar os detalhes de destino como endereço de host ou anexo de serviço. Selecione um dos tipos de destino a seguir:
        • Endereço do host: se você quiser especificar o nome do host ou o endereço IP do destino.
        • Anexo de serviço: se você quiser especificar o endpoint particular para seus endereços IP internos. O anexo de serviço permite ocultar seus endereços IP internos da rede externa. É possível criar um anexo de serviço no Google Cloud usando o recurso Private Service Connect. Para informações sobre como configurar um Private Service Connect, consulte Publicar serviços gerenciados.

        Com base no tipo de destino selecionado, insira o endereço do host ou o nome do anexo do serviço.

        Para inserir mais destinos, clique em +Adicionar destino.

      2. Clique em Próxima.
    4. Na seção Autenticação, insira os detalhes da autenticação.
      1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

        Os seguintes tipos de autenticação são compatíveis com a conexão do HubSpot:

        • Private App Access Token : selecione o Secret do Secret Manager que contém o token de acesso a apps particulares.

          Com os apps particulares, é possível usar as APIs do HubSpot para acessar dados específicos da sua conta. É possível autorizar o que cada app particular pode solicitar ou alterar na sua conta, o que gera um token de acesso exclusivo. No app particular, verifique se você forneceu a permissão de leitura pelo menos para os seguintes escopos:

          • crm.schemas.line_items.read
          • crm.schemas.quotes.read
          • crm.schemas.deals.read
          • crm.schemas.companies.read
          • crm.schemas.custom.read
          • crm.schemas.contacts.read

          Para mais informações, consulte Apps particulares.

      2. Clique em Próxima.
    5. Se você tiver ativado a inscrição de eventos, a seção Detalhes da assinatura de eventos será exibida na página de criação da conexão. Na etapa Detalhes da assinatura do evento, informe os detalhes de autenticação que vão ser usados para validar o payload do token do HubSpot:
      1. Chave secreta do cliente: (opcional) selecione a chave secreta do Secret Manager da chave secreta do cliente do app particular e a versão correspondente do secret na lista suspensa Versão do secret.
      2. Para mais informações, consulte Apps particulares.

      3. Selecione Ativar conectividade particular para conectividade segura entre seu aplicativo de back-end e sua conexão. Se você selecionar essa opção, precisará executar etapas de configuração adicionais depois de criar a conexão. Para mais informações, consulte Conectividade particular para inscrição em eventos.
      4. Insira a configuração de mensagens inativas. Se você configurar a mensagem inativa, a conexão gravará os eventos não processados no tópico do Pub/Sub especificado. Digite os seguintes detalhes:
        1. ID do projeto de mensagens inativas: o ID do projeto do Google Cloud em que você configurou o tópico do Pub/Sub de mensagens inativas.
        2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer escrever os detalhes do evento não processado.
      5. Clique em Próxima.
    6. Revisão: revise os detalhes de conexão e autenticação.
    7. Clique em Criar.

Criar e editar assinaturas de webhook

Para concluir a configuração da assinatura do evento, registre o URL do webhook no aplicativo HubSpot. Portanto, depois que a conexão for criada, execute as seguintes etapas:

  1. Acesse a página de detalhes da conexão recém-criada e copie o URL do webhook da assinatura do evento. O URL do webhook é obrigatório quando você cria uma assinatura na próxima etapa.

    A imagem a seguir mostra o campo Endpoint do listener de eventos na página de detalhes da conexão do HubSpot:

    imagem mostrando a página de detalhes da conexão do HubSpot imagem mostrando a página de detalhes da conexão do HubSpot
  2. Siga as etapas para criar e editar assinaturas de webhook no HubSpot.

Saída do gatilho

O gatilho do HubSpot leva alguns minutos para concluir a configuração da assinatura do evento. É possível ver o status da sua assinatura de eventos no painel de configuração do acionador, em Detalhes da inscrição de eventos.

O acionador do HubSpot indica o status de uma assinatura de evento usando os seguintes estados:

  • Creating: indica que o acionador está assinando a assinatura do evento.
  • Active: indica que o acionador foi inscrito em uma assinatura de evento.
  • Error: indica que há um problema com a inscrição de eventos configurada.

Além do status da inscrição no evento, a seção Detalhes da inscrição no evento também exibe outras informações, como região da conexão, nome da conexão, nome da inscrição do evento e muito mais.

A imagem a seguir mostra um exemplo de layout do painel de configuração do gatilho do HubSpot:

imagem mostrando o painel de configuração do gatilho do HubSpot imagem mostrando o painel de configuração do gatilho do HubSpot

Variável de saída do acionador

Para cada evento, o gatilho do HubSpot gera uma variável de saída ConnectorEventPayload que pode ser usada nas tarefas downstream. A variável de saída está no formato JSON que contém o esquema de payload de saída do HubSpot.

Ver inscrições em eventos

Para conferir e gerenciar todas as assinaturas de eventos associadas a uma conexão no Integration Connectors, faça o seguinte:

  1. Acesse a página Conectores de integração > Conexões.

    Acessar a página "Conexões"

  2. Clique na conexão em que você quer exibir as assinaturas.
  3. Clique na guia Inscrições em eventos.

    Todas as inscrições de eventos da conexão são exibidas.

Editar gatilho do HubSpot

É possível editar um acionador do HubSpot para mudar ou atualizar a configuração da conexão e os detalhes da inscrição de eventos.

Para editar um gatilho do HubSpot, siga estas etapas:

  1. Clique no elemento gatilho do HubSpot no editor de integração para abrir o painel de configuração do acionador.
  2. Clique em Configurar gatilho do HubSpot.
  3. Faça o seguinte na página Editor do gatilho de evento do conector:
    1. Para manter a assinatura de eventos configurada anteriormente, clique em Reter. Caso contrário, clique em Excluir.
    2. Atualize a configuração da conexão e os detalhes da inscrição no evento conforme desejado.
    3. Clique em Concluído.
  4. Você pode ver os detalhes atualizados da conexão e das inscrições de eventos no painel de configuração do acionador, em Detalhes da inscrição de eventos.