Pular para o conteúdo

Freshdesk

Freshdesk

Freshdesk é um software de suporte ao cliente que centraliza tickets, base de conhecimento e automações para equipes de atendimento. Com a integração Freshdesk no SquadOS, seus agentes podem abrir e atualizar tickets, gerenciar contatos e empresas, responder a chamados, adicionar notas internas e publicar artigos na base de conhecimento — tudo de forma programática e sem intervenção manual.

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
api_keySimChave de API da sua conta Freshdesk, encontrada nas configurações de perfil do agente.
  1. Faça login na sua conta Freshdesk.
  2. Clique na sua foto de perfil no canto superior direito e selecione Profile Settings.
  3. No painel direito, localize a opção View API key e complete a verificação de captcha.
  4. Copie a chave exibida — esse é o valor a usar no campo api_key ao conectar no SquadOS.
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Freshdesk.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
  5. 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.)

FRESHDESK_CREATE_TICKET

Cria um novo ticket no Freshdesk. Os campos subject e description são sempre obrigatórios. Ao menos um identificador do solicitante também é obrigatório: requester_id, email, phone, facebook_id, twitter_id ou unique_external_id. Se apenas phone for informado sem email, o campo name torna-se obrigatório.

NomeTipoObrigatórioDescrição
subjectstringSimAssunto do ticket. Deve ser uma string não vazia.
descriptionstringSimConteúdo HTML do ticket. Suporta formatação HTML como <p>, <strong>, <em>, etc.
emailstringNãoEndereço de e-mail do solicitante.
requester_idintegerNãoID do usuário solicitante.
phonestringNãoNúmero de telefone do solicitante.
namestringNãoNome do solicitante.
statusstringNãoStatus do ticket: open, pending, resolved ou closed.
prioritystringNãoPrioridade do ticket: low, medium, high ou urgent.
sourcestringNãoCanal de origem do ticket: email, portal, phone, chat, feedback_widget ou outbound_email.
group_idintegerNãoID do grupo ao qual o ticket foi atribuído.
responder_idintegerNãoID do agente ao qual o ticket foi atribuído.
company_idintegerNãoID da empresa do solicitante.
tagsarrayNãoTags associadas ao ticket.
due_bystringNãoPrazo de resolução do ticket no formato ISO 8601 (ex.: 2026-01-30T15:00:00Z).
fr_due_bystringNãoPrazo para a primeira resposta no formato ISO 8601.
cc_emailsarrayNãoEndereços de e-mail adicionados no campo cc.
custom_fieldsobjectNãoPares chave-valor de campos personalizados (ex.: {"cf_campo": "valor"}).
product_idintegerNãoID do produto vinculado ao ticket.
twitter_idstringNãoHandle do Twitter do solicitante.
facebook_idstringNãoID do Facebook do solicitante.
unique_external_idstringNãoID externo do solicitante.
email_config_idintegerNãoID da configuração de e-mail utilizada para este ticket.
attachmentsarrayNãoAnexos do ticket. Requerem formato multipart/form-data; não são suportados via JSON.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_VIEW_TICKET

Recupera os detalhes de um ticket existente no Freshdesk. Os dados do ticket são retornados dentro do campo response_data na resposta.

NomeTipoObrigatórioDescrição
ticket_idintegerSimID do ticket a ser visualizado.
includestringNãoLista separada por vírgula de informações adicionais a incluir na resposta. Valores válidos: stats (estatísticas de tempo), requester (dados do solicitante), company (informações da empresa).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_GET_TICKETS

Recupera uma lista de tickets do Freshdesk com suporte a filtros e paginação. Os tickets são retornados no campo response_data da resposta.

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página para paginação.
per_pageintegerNãoQuantidade de tickets por página.
filterstringNãoFiltro predefinido: new_and_my_open, watching, spam, deleted, entre outros.
statusstringNãoFiltrar por status: open, pending, resolved, closed, waiting_on_customer ou waiting_on_third_party.
prioritystringNãoFiltrar por prioridade: low, medium, high ou urgent.
agent_idintegerNãoFiltrar tickets por ID do agente.
group_idintegerNãoFiltrar tickets por ID do grupo.
requester_idintegerNãoFiltrar tickets por ID do solicitante.
sort_bystringNãoCampo de ordenação, ex.: created_at.
sort_orderstringNãoDireção da ordenação: asc ou desc.
created_sincestringNãoRecuperar tickets criados desde esta data/hora no formato YYYY-MM-DDTHH:MM:SSZ.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_UPDATE_TICKET

Atualiza os atributos de um ticket existente no Freshdesk, como assunto, prioridade, status, descrição ou campos personalizados.

NomeTipoObrigatórioDescrição
ticket_idintegerSimID do ticket a ser atualizado.
subjectstringNãoAssunto do ticket.
descriptionstringNãoConteúdo HTML da descrição do ticket.
statusstringNãoNovo status: open, pending, resolved, closed, waiting_on_customer ou waiting_on_third_party.
prioritystringNãoNova prioridade: low, medium, high ou urgent.
sourcestringNãoCanal de origem.
typestringNãoTipo do ticket (ex.: Question, Incident, Problem, Feature Request). Tipos personalizados do seu Freshdesk também são aceitos.
group_idintegerNãoID do grupo ao qual o ticket está atribuído.
responder_idintegerNãoID do agente ao qual o ticket está atribuído.
company_idintegerNãoID da empresa associada ao solicitante.
tagsarrayNãoTags a associar ao ticket.
due_bystringNãoNovo prazo de resolução no formato ISO 8601.
fr_due_bystringNãoNovo prazo para a primeira resposta no formato ISO 8601.
parent_idintegerNãoID do ticket pai para vincular este ticket.
custom_fieldsobjectNãoCampos personalizados (ex.: {"cf_reference_number": "REF-123"}).
emailstringNãoE-mail do solicitante.
namestringNãoNome do solicitante.
phonestringNãoTelefone do solicitante.
requester_idintegerNãoID do solicitante.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_DELETE_TICKET

Exclui permanentemente um ticket do Freshdesk. Após a exclusão, o ticket não pode ser restaurado.

NomeTipoObrigatórioDescrição
ticket_idintegerSimIdentificador único do ticket a ser excluído.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_REPLY_TO_TICKET

Cria uma resposta pública para um ticket de suporte existente. A resposta é enviada ao solicitante e aos destinatários em cópia. Suporta conteúdo em HTML e controle de distribuição de e-mail.

NomeTipoObrigatórioDescrição
ticket_idintegerSimIdentificador único do ticket a responder.
bodystringSimConteúdo da resposta. Pode conter formatação HTML.
user_idintegerNãoID do agente que está criando a resposta. Use para responder em nome de outro usuário.
from_emailstringNãoE-mail de suporte utilizado como remetente. Por padrão, usa o e-mail de origem do ticket.
cc_emailsarrayNãoEndereços de e-mail a incluir no campo cc. Máximo de 50 destinatários no total entre to/cc/bcc.
bcc_emailsarrayNãoEndereços de e-mail a incluir no campo bcc.
to_emailsarrayNãoDestinatários diretos, substituindo o solicitante padrão. Requer o recurso multiple_to habilitado na conta.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_ADD_NOTE_TO_TICKET

Adiciona uma nota privada ou pública a um ticket existente no Freshdesk. Notas privadas são visíveis apenas para agentes; notas públicas também são visíveis para o solicitante.

NomeTipoObrigatórioDescrição
ticket_idintegerSimIdentificador único do ticket ao qual a nota será adicionada.
bodystringSimConteúdo da nota. Pode conter texto simples ou HTML.
privatebooleanNãoIndica se a nota é privada (visível apenas para agentes). Padrão: true.
user_idintegerNãoID do usuário que está criando a nota (útil para postar em nome de outro usuário).
notify_emailsarrayNãoEndereços de e-mail de agentes a notificar sobre a nota. Somente endereços de agentes são aceitos.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_BULK_UPDATE_TICKETS

Atualiza múltiplos tickets simultaneamente. A operação é executada de forma assíncrona e retorna um job_id para acompanhamento do progresso.

NomeTipoObrigatórioDescrição
idsarraySimArray com os IDs dos tickets a atualizar em massa (ex.: [18, 17, 123]).
propertiesobjectSimObjeto com os campos a atualizar e seus novos valores. Pelo menos uma propriedade deve ser especificada.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_CREATE_CONTACT

Cria um novo contato no Freshdesk. O campo name é obrigatório; ao menos um dos campos email ou phone deve ser informado.

NomeTipoObrigatórioDescrição
namestringSimNome do contato.
emailstringNãoEndereço de e-mail principal do contato.
phonestringNãoNúmero de telefone do contato.
mobilestringNãoNúmero de celular do contato.
job_titlestringNãoCargo do contato.
company_idintegerNãoID da empresa principal associada a este contato.
addressstringNãoEndereço físico do contato.
descriptionstringNãoNotas ou descrição sobre o contato.
tagsarrayNãoTags associadas ao contato.
languagestringNãoCódigo do idioma preferido do contato.
time_zonestringNãoFuso horário do contato.
twitter_idstringNãoHandle do Twitter do contato.
other_emailsarrayNãoEndereços de e-mail adicionais do contato.
custom_fieldsobjectSimCampos personalizados. Os nomes das chaves não devem ter o prefixo cf_.
view_all_ticketsbooleanNãoSe true, o contato pode visualizar todos os tickets da sua empresa.
unique_external_idstringNãoID externo do contato para fins de integração.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_GET_CONTACTS

Recupera todos os contatos de uma conta Freshdesk com suporte a filtros e paginação. Os resultados são paginados; itere pelas páginas usando page e per_page (máx. 100) para obter o conjunto completo.

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página para paginação. Começa em 1. Padrão: 1.
per_pageintegerNãoQuantidade de contatos por página. Máximo: 100. Padrão: 30.
emailstringNãoFiltrar contatos por endereço de e-mail.
phonestringNãoFiltrar contatos por número de telefone (somente dígitos).
mobilestringNãoFiltrar contatos por número de celular (somente dígitos).
statestringNãoFiltrar contatos por estado.
company_idintegerNãoFiltrar contatos de uma empresa específica pelo ID da empresa.
updated_sincestringNãoRecuperar contatos modificados após a data/hora especificada no formato ISO 8601.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_GET_CONTACT

Recupera as informações detalhadas de um contato específico pelo ID.

NomeTipoObrigatórioDescrição
contact_idintegerSimIdentificador único do contato a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_UPDATE_CONTACT

Atualiza as informações de um contato existente no Freshdesk, como nome, e-mail, telefone, cargo ou campos personalizados.

NomeTipoObrigatórioDescrição
idintegerSimID do contato a atualizar.
namestringNãoNome atualizado do contato.
emailstringNãoEndereço de e-mail atualizado.
phonestringNãoNúmero de telefone atualizado.
mobilestringNãoNúmero de celular atualizado.
job_titlestringNãoCargo atualizado.
company_idintegerNãoID da empresa principal atualizado.
addressstringNãoEndereço físico atualizado.
descriptionstringNãoNotas ou descrição atualizadas.
tagsarrayNãoTags atualizadas.
languagestringNãoCódigo de idioma atualizado.
time_zonestringNãoFuso horário atualizado.
twitter_idstringNãoHandle do Twitter atualizado.
other_emailsarrayNãoEndereços de e-mail adicionais atualizados.
custom_fieldsobjectNãoCampos personalizados atualizados.
view_all_ticketsbooleanNãoSe true, o contato pode visualizar todos os tickets da empresa.
unique_external_idstringNãoID externo atualizado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_DELETE_CONTACT

Faz a exclusão suave de um contato no Freshdesk, movendo-o de Todos os Contatos para a visualização de Contatos Excluídos. Comunicações futuras desse contato serão direcionadas para SPAM. O contato pode ser restaurado; para exclusão permanente, use a ação de exclusão definitiva.

NomeTipoObrigatórioDescrição
contact_idintegerSimIdentificador único do contato a ser excluído suavemente.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_SEARCH_CONTACTS

Busca e filtra contatos no Freshdesk usando pesquisa baseada em consulta. Útil para encontrar contatos por e-mail, telefone, celular, company_id ou outros atributos pesquisáveis.

NomeTipoObrigatórioDescrição
querystringSimString de consulta para filtrar contatos. Deve ser envolvida em aspas duplas. Formato: "campo:valor" para strings ou "campo:número" para valores numéricos. Campos pesquisáveis: email, phone, mobile, company_id, active. Suporta operadores lógicos AND e OR. Limitado a 512 caracteres.
pageintegerNãoNúmero da página para paginação. Começa em 1 e não pode exceder 10. Retorna no máximo 30 resultados por página.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_CREATE_COMPANIES

Cria uma nova empresa no Freshdesk. Empresas podem conter múltiplos contatos e são associadas automaticamente com base no domínio de e-mail.

NomeTipoObrigatórioDescrição
namestringSimNome da empresa.
domainsarrayNãoArray de domínios associados à empresa. O Freshdesk associa contatos automaticamente se o e-mail contiver um dos domínios especificados.
descriptionstringNãoDescrição sobre a empresa.
notestringNãoNotas adicionais sobre a empresa.
industrystringNãoClassificação do setor (disponível no plano Blossom e superiores).
account_tierstringNãoNível da conta: Basic, Premium ou Enterprise.
health_scorestringNãoPontuação de saúde: Happy, Doing okay ou At risk.
renewal_datestringNãoData de renovação do contrato no formato YYYY-MM-DD.
custom_fieldsobjectNãoCampos personalizados da empresa. As chaves não levam o prefixo cf_.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_GET_COMPANIES

Recupera todas as empresas de uma conta Freshdesk com suporte a paginação.

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página para paginação. Começa em 1. Padrão: 1.
per_pageintegerNãoQuantidade de empresas por página. Máximo: 100. Padrão: 30.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_GET_COMPANY

Recupera as informações detalhadas de uma empresa específica pelo ID, incluindo domínios e campos personalizados.

NomeTipoObrigatórioDescrição
company_idintegerSimIdentificador único da empresa a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_DELETE_COMPANY

Exclui permanentemente uma empresa do Freshdesk. A exclusão desfaz o vínculo da empresa mas não exclui os contatos dentro dela. Após excluída, a empresa não pode ser restaurada.

NomeTipoObrigatórioDescrição
company_idintegerSimIdentificador único da empresa a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_SEARCH_COMPANY

Busca empresas por nome ou nome parcial usando a funcionalidade de autocompletar do Freshdesk.

NomeTipoObrigatórioDescrição
namestringSimNome ou nome parcial da empresa a buscar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_GET_AGENT

Recupera as informações detalhadas de um agente específico pelo ID, incluindo perfil, informações de contato, disponibilidade e atribuições de papéis.

NomeTipoObrigatórioDescrição
agent_idintegerSimIdentificador único do agente a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_SEARCH_AGENTS

Busca e filtra agentes no Freshdesk por e-mail, telefone, celular ou tipo (integral/eventual).

NomeTipoObrigatórioDescrição
emailstringNãoFiltrar agentes por endereço de e-mail.
phonestringNãoFiltrar agentes por número de telefone.
mobilestringNãoFiltrar agentes por número de celular.
statestringNãoFiltrar agentes pelo tipo: fulltime (integral) ou occasional (eventual).
pageintegerNãoNúmero da página de resultados.
per_pageintegerNãoQuantidade de resultados por página.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_CREATE_SOLUTION_ARTICLE

Cria um novo artigo na base de conhecimento do Freshdesk dentro de uma pasta de soluções. Use para adicionar documentação, FAQs ou conteúdo de ajuda.

NomeTipoObrigatórioDescrição
folder_idintegerSimIdentificador único da pasta onde o artigo será criado.
titlestringSimTítulo do artigo de solução.
descriptionstringSimConteúdo do artigo em formato HTML.
statusstringNãoStatus de publicação: draft (rascunho) ou published (publicado).
agent_idintegerNãoID do agente criando o artigo. Por padrão, usa o agente autenticado.
tagsarrayNãoTags para categorizar o artigo.
seo_dataobjectNãoDados de SEO para o artigo.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FRESHDESK_LIST_SOLUTION_ARTICLES

Recupera todos os artigos de solução dentro de uma pasta especificada no Freshdesk.

NomeTipoObrigatórioDescrição
folder_idintegerSimIdentificador único da pasta de soluções da qual recuperar artigos.
pageintegerNãoNúmero da página para paginação. Cada página retorna até 30 artigos.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.