Gatilho do HubSpot

Prévia : gatilho do HubSpot

Este recurso está sujeito aos Termos das Soluções Pré-GA na seção Termos Gerais de Serviço dos Termos Específicos de Serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

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

Importante: Integration Connectors é um componente faturável do Google Cloud. Para informações sobre os custos e as cobranças de uso dos Integration Connectors, consulte os preços dos Integration Connectors.

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 mais informações sobre como conceder papéis, consulte Gerenciar o 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 vai receber. Os seguintes tipos de assinatura são compatíveis:

• deal.creation
• deal.propertyChange
• deal.deletion
• contact.creation
• contact.propertyChange
• contact.deletion

Adicionar o gatilho do HubSpot

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

1. No Google Cloud console do, 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 na nuvem do Google Cloud.

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

   Caso você esteja criando uma nova integração, siga estas etapas:

   1. Insira um nome e uma descrição no painel Criar integração.
   2. Selecione uma região para a integração.
      Observação: o menu suspenso Regiões lista apenas as regiões provisionadas no projeto do Google Cloud. Para provisionar uma nova região, clique em Ativar região. Consulte Ativar nova região para obter mais informações.
   3. Selecione uma conta de serviço para a integração. É possível mudar ou atualizar os detalhes da conta de serviço de uma integração a qualquer momento no painel de informações Resumo da integração na barra de ferramentas de integração.
      Observação:a opção de selecionar uma conta de serviço só será exibida se você tiver ativado a governança de integração para a região selecionada.
   4. Clique em Criar.

   A integração recém-criada será aberta no 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 posicione o elemento gatilho do HubSpot no editor de integração.

Para configurar o gatilho do HubSpot, use uma conexão do HubSpot disponível no Integration Connectors ou crie uma nova conexão do HubSpot 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 do HubSpot em Integration Connectors. O gatilho do HubSpot é um gatilho de evento de conector. Portanto, só é possível usar uma conexão do HubSpot com a assinatura de eventos ativada para configurar o gatilho.

Para informações sobre como configurar um gatilho do HubSpot usando uma nova conexão do HubSpot, consulte Configurar o gatilho do HubSpot usando uma nova conexão

Para configurar um gatilho do HubSpot usando uma 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 gatilho.
2. Clique em Configurar gatilho.
3. Forneça os seguintes detalhes de configuração na página Editor de 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.

      O Application Integration mostra apenas as conexões do HubSpot que estão ativas e têm uma assinatura de evento ativada.

   3. Tipo de evento:selecione o tipo de evento que você quer usar para acionar a integração. Para conferir uma lista de tipos de eventos compatíveis, consulte Tipos de eventos 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 concluir a configuração do gatilho 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 gatilho.
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. Conclua as etapas a seguir 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 49 caracteres.
         • Para conectores que oferecem suporte à assinatura de eventos, os nomes de conexão não podem começar com o prefixo "goog".
      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 para assinaturas de eventos, selecione Ativar assinatura de eventos. Ao selecionar essa opção, as seguintes opções serão exibidas:
         • Ativar assinatura de eventos com entidade e ações: selecione essa opção para usar a conexão para assinatura de eventos e operações de conector (entidades e ações).
         • Ativar apenas a assinatura de eventos: selecione essa opção para usar a conexão apenas para assinatura de eventos. Se você selecionar essa opção, clique em Próxima e, em seguida, configure a assinatura de eventos.
      7. Esquema: especifique a versão da API do HubSpot a ser usada. O 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. Propriedades de contatos: insira os nomes de campo separados por vírgulas da entidade Contacts que você quer selecionar na operação da entidade List. Por exemplo, fieldA, fieldB, fieldC
      10. Propriedades de empresas: insira os nomes de campo separados por vírgulas da entidade Companies que você quer selecionar na operação da entidade List. Por exemplo, fieldA, fieldB, fieldC
      11. Propriedades de negócios: insira os nomes de campo separados por vírgulas da entidade Deals que você quer selecionar na operação da entidade List. Por exemplo, fieldA, fieldB, fieldC
      12. Usar proxy: marque esta 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 no proxy do ProxyServer.
      14. Usuário proxy: um nome de usuário a ser usado para autenticar no proxy do ProxyServer.
      15. Senha do proxy: uma senha a ser usada para autenticar no proxy do ProxyServer.
      16. Tipo de SSL de proxy: o tipo de SSL a ser usado ao se conectar ao 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.

      Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por uso.
      18. Outra opção é clicar em + Adicionar marcador para adicionar um marcador à 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 outros 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.

         A conexão do HubSpot oferece suporte aos seguintes tipos de autenticação:

         • Token de acesso do app particular : selecione o Secret do Secret Manager que contém o token de acesso do app particular.

           Os apps particulares permitem usar as APIs do HubSpot para acessar dados específicos da sua conta do HubSpot. É possível autorizar o que cada app particular pode solicitar ou mudar na sua conta, o que vai gerar um token de acesso exclusivo para seu app particular. No app particular, verifique se você concedeu a permissão de leitura pelo menos aos 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ê ativou a assinatura de eventos, a seção Detalhes da assinatura de eventos vai aparecer na página de criação de conexão. Na etapa Detalhes da assinatura de eventos, forneça os detalhes de autenticação que serão usados para validar o payload do token do HubSpot:
      1. Chave secreta do cliente: (opcional) selecione o Secret do Secret Manager da chave secreta do cliente do seu app particular e a versão secreta correspondente no menu suspenso Versão secreta.

      Para mais informações, consulte Apps particulares.

      2. Selecione Ativar conectividade particular para conectividade segura entre o aplicativo de back-end e a conexão. Se você selecionar essa opção, será necessário executar mais etapas de configuração depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinatura de eventos.
      3. Insira a configuração de mensagens não entregues. Se você configurar mensagens não entregues, a conexão vai gravar os eventos não processados no tópico do Pub/Sub especificado. Insira os seguintes detalhes:
         1. ID do projeto de mensagens não entregues: o ID do projeto na nuvem do Google Cloud em que você configurou o tópico do Pub/Sub de mensagens não entregues.
         2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.
      4. 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 de eventos, registre o URL do webhook no aplicativo do HubSpot. Portanto, depois que a criação da conexão for concluída, siga estas etapas adicionais:

1. Acesse a página de detalhes da conexão recém-criada e copie o URL do webhook para a assinatura de eventos. O URL do webhook é necessário ao criar uma assinatura de webhook 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:

   
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 de eventos. É possível conferir o status da assinatura de eventos no painel de configuração do gatilho em Detalhes da assinatura de eventos.

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

• Creating: indica que o gatilho está se inscrevendo na assinatura de eventos.
• Active: indica que o gatilho foi inscrito em uma assinatura de eventos.
• Error: indica que há um problema com a assinatura de eventos configurada.

Além do status da assinatura de eventos, a seção Detalhes da assinatura de eventos também mostra outros detalhes, como região de conexão, nome da conexão, nome da assinatura de eventos e muito mais.

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

Variável de saída do gatilho

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, contendo o esquema de payload de saída do HubSpot.

Conferir assinaturas de 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 Integration Connectors > Conexões.

   Acessar a página Conexões

2. Clique na conexão para a qual você quer conferir as assinaturas.
3. Clique na guia Assinaturas de eventos.

   Isso mostra todas as assinaturas de eventos da conexão.

Editar o gatilho do HubSpot

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

Importante:ao editar ou modificar um gatilho do HubSpot, é possível manter a assinatura de eventos configurada anteriormente anexada ao gatilho ou excluí-la. A exclusão de uma assinatura de eventos afeta todas as integrações publicadas que usam essa assinatura 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 gatilho.
2. Clique em Configurar gatilho do HubSpot.
3. Faça o seguinte na página Editor de gatilho de evento do conector :
   1. Para manter a assinatura de eventos configurada anteriormente, clique em Manter ou em Excluir.
      Aviso:a exclusão de uma assinatura de eventos afeta todas as integrações publicadas que usam a assinatura de eventos. Esta tarefa não pode ser desfeita.
   2. Atualize a configuração de conexão e os detalhes da assinatura de eventos conforme desejado.
   3. Clique em Concluído.

É possível conferir os detalhes atualizados da conexão e da assinatura de eventos no painel de configuração do gatilho em Detalhes da assinatura de eventos.

Cotas e limites

Para informações sobre o assunto, consulte Cotas e limites.

A seguir

• Saiba mais sobre todas as tarefas e acionadores.
• Saiba como testar e publicar uma integração.
• Saiba mais sobre o tratamento de erros.
• Saiba mais sobre os registros de execução de integração.