HubSpot
Visão geral
Seção intitulada “Visão geral”HubSpot é uma plataforma de inbound marketing, vendas e atendimento ao cliente que integra CRM, automação de e-mail e analytics para facilitar a nutrição de leads e proporcionar experiências de cliente fluidas. Com a integração HubSpot no SquadOS, seus agentes podem criar e atualizar contatos, negócios, empresas e tickets, executar buscas avançadas no CRM e automatizar fluxos de trabalho sem nenhuma intervenção manual.
- Site oficial: https://www.hubspot.com/
- Documentação na Composio: docs.composio.dev/toolkits/hubspot
Autenticação
Seção intitulada “Autenticação”Esta ferramenta suporta dois modos de autenticação: OAuth 2.0 (OAUTH2) e chave de API (API_KEY). O modo OAuth 2.0 é recomendado para a maioria dos casos, pois não exige geração manual de tokens.
OAuth 2.0
Seção intitulada “OAuth 2.0”No modo OAuth, você autoriza o acesso diretamente na página de conexão da Composio — não é necessário gerar credenciais manualmente.
Chave de API (API_KEY)
Seção intitulada “Chave de API (API_KEY)”Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Chave de API privada do HubSpot. Acesse Configurações → Integrações → Chave de API no painel HubSpot. |
Como obter a credencial
Seção intitulada “Como obter a credencial”Para instruções detalhadas sobre como configurar credenciais OAuth ou chave de API para o HubSpot na Composio, consulte: composio.dev/auth/hubspot.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
HubSpot. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth 2.0 ou informa a chave de API obtida acima.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Como configurar credenciais OAuth customizadas para o HubSpot?
Seção intitulada “Como configurar credenciais OAuth customizadas para o HubSpot?”Para um guia passo a passo sobre como criar e configurar suas próprias credenciais OAuth do HubSpot na Composio, consulte Como criar credenciais OAuth para o HubSpot.
Por que recebo erros com limit nas buscas de contatos do HubSpot?
Seção intitulada “Por que recebo erros com limit nas buscas de contatos do HubSpot?”As ações HUBSPOT_SEARCH_CONTACTS_BY_CRITERIA e HUBSPOT_LIST_CONTACTS_PAGE têm limite máximo de 100 resultados por requisição. Defina limit como 100 ou menos para evitar erros.
Por que não consigo configurar webhooks para o HubSpot?
Seção intitulada “Por que não consigo configurar webhooks para o HubSpot?”Os webhooks do HubSpot exigem um app público com App ID e Developer API Key. Apps privados ou internos não conseguem receber webhooks.
Ações disponíveis
Seção intitulada “Ações disponíveis”Obter informações da conta
Seção intitulada “Obter informações da conta”HUBSPOT_GET_ACCOUNT_INFO
Retorna as informações atuais da conta HubSpot (e-mail, hubId, detalhes do usuário) usando lookup por token de acesso.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar contatos
Seção intitulada “Listar contatos”HUBSPOT_LIST_CONTACTS
Retorna uma lista paginada de contatos do HubSpot.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Token de paginação do campo paging.next.after de uma resposta anterior para buscar a próxima página. Omita para a primeira página. |
limit | integer | Não | Número máximo de contatos a retornar por página (padrão: 10). |
archived | boolean | Não | true retorna apenas contatos arquivados; false (padrão) retorna apenas ativos. |
properties | array | Não | Lista de nomes internos de propriedades a incluir na resposta. Se omitido, retorna um conjunto padrão. |
associations | array | Não | Lista de tipos de objetos (ex.: companies, deals) para recuperar IDs associados com cada contato. |
propertiesWithHistory | array | Não | Lista de propriedades para recuperar valores históricos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar contatos por critérios
Seção intitulada “Buscar contatos por critérios”HUBSPOT_SEARCH_CONTACTS_BY_CRITERIA
Busca contatos do HubSpot usando uma query de texto, critérios de filtro específicos (filtros dentro de um grupo são combinados com AND; grupos são combinados com OR), ordenação e paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Token de cursor para paginação. Use o valor after de paging.next de uma resposta anterior para buscar o próximo conjunto de resultados. |
limit | integer | Não | Número máximo de contatos a retornar. Máximo de 100. |
query | string | Não | Texto para buscar nas propriedades padrão pesquisáveis: firstname, lastname, email, phone, company. NÃO busca propriedades customizadas — use filterGroups para isso. |
sorts | array | Não | Lista de critérios de ordenação. Exemplo: [{'propertyName': 'lastname', 'direction': 'ASCENDING'}]. |
properties | array | Não | Lista de nomes internos de propriedades a incluir na resposta. |
filterGroups | array | Não | Lista de grupos de filtros. Máximo de 5 grupos e 18 filtros totais. Filtros dentro de um grupo são ANDed; grupos são ORed. |
custom_properties | array | Não | Nomes internos de propriedades customizadas a recuperar (alias conveniente que é mesclado em properties). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Ler contato
Seção intitulada “Ler contato”HUBSPOT_READ_CONTACT
Recupera um contato do HubSpot pelo seu ID.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contactId | string | Sim | ID interno único do objeto CRM do contato no HubSpot. |
archived | boolean | Não | true para incluir apenas contatos arquivados; padrão false (ativos). |
properties | array | Não | Nomes de propriedades a incluir na resposta. |
associations | array | Não | Tipos de objetos (ex.: companies, deals) para incluir IDs associados. |
propertiesWithHistory | array | Não | Nomes de propriedades para incluir valores históricos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar contato
Seção intitulada “Criar contato”HUBSPOT_CREATE_CONTACT
Cria um novo contato no HubSpot.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | Não | Endereço de e-mail principal do contato. É um identificador único para contatos no HubSpot. |
firstname | string | Não | Primeiro nome do contato. |
lastname | string | Não | Sobrenome do contato. |
phone | string | Não | Telefone principal do contato. |
company | string | Não | Nome da empresa onde o contato trabalha. |
jobtitle | string | Não | Cargo do contato. |
website | string | Não | URL do site pessoal ou da empresa do contato. |
associations | array | Não | Lista de associações a criar com outros objetos HubSpot existentes (ex.: empresas, negócios). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar contato
Seção intitulada “Atualizar contato”HUBSPOT_UPDATE_CONTACT
Atualiza propriedades de um contato HubSpot existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contactId | string | Sim | Identificador único HubSpot do contato a ser atualizado. |
properties | object | Não | Propriedades padrão do contato HubSpot a atualizar. |
custom_properties | object | Não | Propriedades customizadas a atualizar. As chaves devem ser nomes internos das propriedades (ex.: my_custom_field). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Mesclar contatos
Seção intitulada “Mesclar contatos”HUBSPOT_MERGE_CONTACTS
Mescla dois contatos HubSpot em um único registro.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
primaryObjectId | string | Sim | ID do contato que permanecerá após a mesclagem e absorverá as informações do outro. |
objectIdToMerge | string | Sim | ID do contato que será mesclado no contato principal e excluído após a operação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar propriedades de contatos
Seção intitulada “Listar propriedades de contatos”HUBSPOT_LIST_CONTACT_PROPERTIES
Lista todas as propriedades de contato da sua conta HubSpot, incluindo propriedades customizadas. Útil para descobrir nomes internos de propriedades para uso em filtros e atualizações.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
archived | boolean | Não | true para incluir propriedades arquivadas. |
custom_only | boolean | Não | true para retornar apenas propriedades customizadas (exclui as padrão do HubSpot). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar empresas
Seção intitulada “Listar empresas”HUBSPOT_LIST_COMPANIES
Retorna uma lista paginada de empresas do HubSpot.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Token de paginação para buscar a próxima página. |
limit | integer | Não | Número máximo de empresas por página (padrão: 10). |
archived | boolean | Não | true retorna apenas empresas arquivadas; false (padrão) retorna apenas ativas. |
properties | array | Não | Lista de nomes internos de propriedades a incluir na resposta. |
associations | array | Não | Tipos de objetos para recuperar IDs associados com cada empresa. |
propertiesWithHistory | array | Não | Propriedades para recuperar valores históricos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar empresas
Seção intitulada “Buscar empresas”HUBSPOT_SEARCH_COMPANIES
Busca empresas no HubSpot usando critérios e filtros flexíveis.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Cursor de paginação; use paging.next.after de uma resposta anterior. |
limit | integer | Não | Número máximo de empresas a retornar. |
query | string | Não | Texto para buscar nas propriedades padrão de empresas. |
sorts | array | Não | Lista de objetos de ordenação. Máximo de 1 critério. |
properties | array | Não | Nomes internos de propriedades a incluir na resposta. |
filterGroups | array | Não | Grupos de filtros; filtros dentro de um grupo são ANDed, grupos são ORed. |
custom_properties | array | Não | Nomes internos de propriedades customizadas a incluir na resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter empresa
Seção intitulada “Obter empresa”HUBSPOT_GET_COMPANY
Recupera uma empresa do HubSpot pelo seu ID.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
companyId | string | Sim | Identificador único HubSpot da empresa a recuperar. |
archived | boolean | Não | true para incluir apenas empresas arquivadas; padrão false. |
properties | array | Não | Nomes de propriedades a incluir na resposta. Use "all" para recuperar todas as propriedades. |
associations | array | Não | Tipos de objetos para incluir IDs associados. |
propertiesWithHistory | array | Não | Propriedades para incluir valores históricos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar empresa
Seção intitulada “Criar empresa”HUBSPOT_CREATE_COMPANY
Cria uma nova empresa no HubSpot.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Nome da empresa. |
domain | string | Não | Domínio principal da empresa. |
phone | string | Não | Telefone principal da empresa. |
website | string | Não | URL do site da empresa. |
city | string | Não | Cidade onde a empresa está localizada. |
state | string | Não | Estado ou região onde a empresa está localizada. |
country | string | Não | País onde a empresa está localizada. |
industry | string | Não | Setor da empresa. Deve ser um dos valores enum predefinidos do HubSpot em SCREAMING_SNAKE_CASE (ex.: COMPUTER_SOFTWARE, FINANCIAL_SERVICES). |
description | string | Não | Breve descrição da empresa. |
annualrevenue | string | Não | Receita anual da empresa. |
associations | array | Não | Lista de associações a criar com outros objetos HubSpot. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar empresa
Seção intitulada “Atualizar empresa”HUBSPOT_UPDATE_COMPANY
Atualiza propriedades de uma empresa HubSpot existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
companyId | string | Sim | Identificador único HubSpot da empresa a ser atualizada. |
properties | object | Sim | Propriedades da empresa a atualizar. As chaves são nomes internos do HubSpot. Use string vazia para limpar um campo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar negócios
Seção intitulada “Listar negócios”HUBSPOT_LIST_DEALS
Retorna uma lista paginada de negócios do HubSpot.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Token de paginação para buscar a próxima página. |
limit | integer | Não | Número máximo de negócios por página (padrão: 10, máximo: 100). |
archived | boolean | Não | true para negócios arquivados; false (padrão) para negócios ativos. |
properties | array | Não | Nomes de propriedades a incluir na resposta. |
associations | array | Não | Tipos de objetos para recuperar IDs associados. |
propertiesWithHistory | array | Não | Propriedades para recuperar valores históricos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar negócios
Seção intitulada “Buscar negócios”HUBSPOT_SEARCH_DEALS
Busca negócios do HubSpot usando critérios e filtros flexíveis.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Token de paginação. O limite da API de busca do HubSpot é de 10.000 resultados totais. |
limit | integer | Não | Número máximo de negócios a retornar. |
query | string | Não | Texto para buscar nas propriedades padrão de negócios. |
sorts | array | Não | Critérios de ordenação dos resultados. |
properties | array | Não | Nomes internos de propriedades a incluir na resposta. |
filterGroups | array | Não | Grupos de filtros; filtros dentro de um grupo são ANDed, grupos são ORed. |
custom_properties | array | Não | Nomes internos de propriedades customizadas a incluir na resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter negócio
Seção intitulada “Obter negócio”HUBSPOT_GET_DEAL
Recupera um negócio do HubSpot pelo seu ID.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
dealId | string | Sim | Identificador único HubSpot do negócio a recuperar. |
archived | boolean | Não | true para incluir apenas negócios arquivados; padrão false. |
properties | array | Não | Nomes de propriedades a incluir na resposta. |
associations | array | Não | Tipos de objetos para recuperar IDs associados. |
propertiesWithHistory | array | Não | Propriedades para incluir valores históricos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar negócio
Seção intitulada “Criar negócio”HUBSPOT_CREATE_DEAL
Cria um novo negócio no HubSpot.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
dealname | string | Não | Nome ou título descritivo do negócio. |
amount | string | Não | Valor monetário total do negócio. |
pipeline | string | Não | ID do pipeline de vendas para este negócio (obrigatório na prática). |
dealstage | string | Não | ID válido de estágio do pipeline. Os IDs de estágio devem ser valores reais da configuração do seu pipeline HubSpot. |
closedate | string | Não | Data (AAAA-MM-DD) ou datetime (ISO 8601) de fechamento esperado ou efetivo. |
dealtype | string | Não | Tipo do negócio (ex.: newbusiness, existingbusiness). |
description | string | Não | Descrição detalhada do negócio. |
associations | array | Não | Associações a criar entre o novo negócio e outros objetos CRM. |
hubspot_owner_id | string | Não | ID do usuário HubSpot responsável pelo negócio. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar negócio
Seção intitulada “Atualizar negócio”HUBSPOT_UPDATE_DEAL
Atualiza propriedades de um negócio HubSpot existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
dealId | string | Sim | Identificador único HubSpot do negócio a ser atualizado. |
properties | object | Sim | Propriedades do negócio a atualizar. Deve conter ao menos uma propriedade. As chaves são nomes internos do HubSpot. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar tickets
Seção intitulada “Listar tickets”HUBSPOT_LIST_TICKETS
Retorna uma lista paginada de tickets de suporte do HubSpot.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Token de paginação para buscar a próxima página. |
limit | integer | Não | Número máximo de tickets por página. |
archived | boolean | Não | true para tickets arquivados; false (padrão) para tickets ativos. |
properties | array | Não | Nomes de propriedades a incluir na resposta. |
associations | array | Não | Tipos de objetos para recuperar IDs associados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar tickets
Seção intitulada “Buscar tickets”HUBSPOT_SEARCH_TICKETS
Busca tickets de suporte no HubSpot usando critérios e filtros flexíveis.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Token de cursor para paginação. |
limit | integer | Não | Número máximo de tickets a retornar. |
query | string | Não | Query de busca por texto no conteúdo ou assunto do ticket. |
sorts | array | Não | Lista de critérios de ordenação. |
properties | array | Não | Propriedades dos tickets a incluir na resposta. |
filterGroups | array | Não | Grupos de filtros para aplicar na busca. |
custom_properties | array | Não | Lista de nomes de propriedades customizadas a incluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter ticket
Seção intitulada “Obter ticket”HUBSPOT_GET_TICKET
Recupera um ticket do HubSpot pelo seu ID.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ticketId | string | Sim | Identificador único HubSpot do ticket a recuperar. |
archived | boolean | Não | Filtrar por status de arquivamento. |
properties | array | Não | Nomes de propriedades a incluir na resposta. |
associations | array | Não | Tipos de objetos para recuperar IDs associados. |
propertiesWithHistory | array | Não | Propriedades para incluir valores históricos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar ticket
Seção intitulada “Criar ticket”HUBSPOT_CREATE_TICKET
Cria um novo ticket de suporte no HubSpot.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
subject | string | Não | Linha de assunto ou título do ticket; geralmente obrigatório na prática. |
content | string | Não | Corpo ou descrição principal do ticket, detalhando o problema ou solicitação. |
hs_pipeline | string | Não | ID do pipeline ao qual este ticket pertence; geralmente obrigatório. |
hs_pipeline_stage | string | Não | ID do estágio atual do ticket dentro do pipeline. |
hs_ticket_priority | string | Não | Prioridade do ticket: HIGH, MEDIUM ou LOW. |
hs_ticket_category | string | Não | Categoria do ticket: PRODUCT_ISSUE, BILLING_ISSUE, FEATURE_REQUEST ou GENERAL_INQUIRY. |
source_type | string | Não | Canal de origem do ticket: CHAT, EMAIL, FORM ou PHONE. |
hubspot_owner_id | string | Não | ID do usuário HubSpot responsável pelo ticket. |
associations | array | Não | Lista de associações entre o novo ticket e outros objetos HubSpot. |
custom_properties | object | Não | Dicionário de propriedades customizadas do ticket. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar ticket
Seção intitulada “Atualizar ticket”HUBSPOT_UPDATE_TICKET
Atualiza propriedades de um ticket HubSpot existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ticketId | string | Sim | Identificador único HubSpot do ticket a ser atualizado. |
properties | object | Sim | Propriedades do ticket a atualizar. As chaves são nomes internos do HubSpot. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar nota
Seção intitulada “Criar nota”HUBSPOT_CREATE_NOTE
Cria uma nova nota CRM no HubSpot. Use quando precisar adicionar uma nota com timestamp e associações opcionais a contatos, empresas, negócios ou tickets.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hs_timestamp | string | Sim | Horário de criação da nota. Timestamp UTC em ISO 8601 (ex.: 2021-11-12T15:48:22Z) ou milissegundos Unix. |
hs_note_body | string | Não | Conteúdo textual da nota (até 65.536 caracteres). |
hubspot_owner_id | string | Não | ID do usuário HubSpot a ser atribuído como criador/proprietário desta nota. |
associations | array | Não | Lista de associações para vincular com a nota (ex.: contatos, negócios, empresas). |
hs_attachment_ids | string | Não | Lista de IDs de anexos separada por ponto-e-vírgula. |
custom_properties | object | Não | Dicionário de propriedades customizadas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar tarefa
Seção intitulada “Criar tarefa”HUBSPOT_CREATE_TASK
Cria um novo registro de tarefa CRM. Use quando precisar adicionar uma tarefa com propriedades e associações opcionais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hs_timestamp | string | Sim | Data de vencimento da tarefa em formato ISO 8601 ou milissegundos Unix. |
hs_task_subject | string | Não | Título ou linha de assunto da tarefa. |
hs_task_body | string | Não | Notas ou texto do corpo da tarefa. |
hs_task_type | string | Não | Tipo da tarefa: CALL, EMAIL ou TODO. Padrão: TODO. |
hs_task_status | string | Não | Status atual da tarefa: NOT_STARTED ou COMPLETED. Padrão: NOT_STARTED. |
hs_task_priority | string | Não | Nível de prioridade: LOW, MEDIUM, HIGH ou NONE. |
hubspot_owner_id | string | Não | ID do proprietário HubSpot para atribuir esta tarefa. Use HUBSPOT_RETRIEVE_OWNERS para obter IDs válidos. |
associations | array | Não | Lista de associações para vincular esta tarefa com registros CRM existentes. |
custom_properties | object | Não | Dicionário de propriedades customizadas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar item de linha
Seção intitulada “Criar item de linha”HUBSPOT_CREATE_LINE_ITEM
Cria um novo item de linha no HubSpot. Use para conectar informações de produto a um negócio ou cotação via hs_product_id.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
properties | object | Sim | Propriedades do item de linha a definir. As chaves são nomes internos de propriedades do HubSpot. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar produto
Seção intitulada “Criar produto”HUBSPOT_CREATE_PRODUCT
Cria um novo produto no catálogo do HubSpot. Produtos são itens de catálogo e não podem ser diretamente associados a negócios; use HUBSPOT_CREATE_LINE_ITEM com hs_product_id para conectar um produto a um negócio.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Nome oficial do produto. |
price | number | Não | Preço de venda do produto na moeda padrão da conta HubSpot. |
hs_sku | string | Não | SKU (código de estoque) do produto. |
description | string | Não | Descrição detalhada do produto, suas características e benefícios. |
hs_url | string | Não | URL da página do produto em um site de e-commerce. |
hs_active | boolean | Não | Indica se o produto está ativo e disponível para venda. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar produtos
Seção intitulada “Listar produtos”HUBSPOT_LIST_PRODUCTS
Retorna uma lista paginada de produtos do catálogo HubSpot.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Token de paginação de resposta anterior. |
limit | integer | Não | Número máximo de produtos por página. |
archived | boolean | Não | Filtrar por status de arquivamento. |
properties | array | Não | Lista de nomes de propriedades a incluir na resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar proprietários
Seção intitulada “Recuperar proprietários”HUBSPOT_RETRIEVE_OWNERS
Retorna uma lista de todos os proprietários no CRM HubSpot, incluindo ID, nome, sobrenome, e-mail e ID de usuário.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar todos os pipelines de um tipo de objeto
Seção intitulada “Recuperar todos os pipelines de um tipo de objeto”HUBSPOT_RETRIEVE_ALL_PIPELINES_FOR_SPECIFIED_OBJECT_TYPE
Recupera todos os pipelines do HubSpot para um tipo de objeto CRM especificado, como negócios ou tickets.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
objectType | string | Sim | Tipo de objeto CRM (ex.: deals, tickets) para o qual recuperar os pipelines. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar associação entre objetos
Seção intitulada “Criar associação entre objetos”HUBSPOT_CREATE_OBJECT_ASSOCIATION
Cria ou rotula uma associação entre dois registros CRM usando a API HubSpot Associations v4. Use quando precisar vincular registros (ex.: contato a empresa, negócio a contato) com labels de associação explícitos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
objectType | string | Sim | Tipo do objeto de origem (ex.: contacts, companies, deals, tickets). |
objectId | string | Sim | ID único do registro CRM de origem. |
toObjectType | string | Sim | Tipo do objeto de destino a associar. |
toObjectId | string | Sim | ID único do registro CRM de destino. |
labels | array | Sim | Array de descritores de labels de associação definindo o(s) tipo(s) de relacionamento. Cada label inclui associationCategory e associationTypeId. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar objetos CRM por critérios
Seção intitulada “Buscar objetos CRM por critérios”HUBSPOT_SEARCH_CRM_OBJECTS_BY_CRITERIA
Busca objetos CRM do HubSpot (ex.: contacts, companies) por objectType usando critérios complexos de filtros, ordenação e paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
objectType | string | Sim | Tipo do objeto CRM a buscar. Valores válidos: contacts, companies, deals, tickets, tasks, line_items, products, quotes, calls, emails, meetings, notes ou IDs de objetos customizados como 2-1234567. |
after | string | Não | Cursor para paginação. O limite máximo da API é de 10.000 resultados totais. |
limit | integer | Não | Máximo de resultados por página (padrão: 10, máximo: 100). |
query | string | Não | Texto para busca ampla em múltiplos campos do objeto. |
sorts | array | Não | Lista de regras de ordenação. Apenas uma regra de ordenação pode ser aplicada por busca. |
properties | array | Não | Lista de nomes de propriedades a incluir na resposta. |
filterGroups | array | Não | Lista de grupos de filtros (AND dentro, OR entre). Máximo de 5 grupos com até 6 filtros cada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |