Freshdesk
Visão geral
Seção intitulada “Visão geral”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.
- Site oficial: https://freshdesk.com/
- Documentação na Composio: docs.composio.dev/toolkits/freshdesk
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza chave de API (API_KEY) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Chave de API da sua conta Freshdesk, encontrada nas configurações de perfil do agente. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Faça login na sua conta Freshdesk.
- Clique na sua foto de perfil no canto superior direito e selecione Profile Settings.
- No painel direito, localize a opção View API key e complete a verificação de captcha.
- Copie a chave exibida — esse é o valor a usar no campo
api_keyao conectar no SquadOS.
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
Freshdesk. - 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 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.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Criar ticket
Seção intitulada “Criar ticket”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
subject | string | Sim | Assunto do ticket. Deve ser uma string não vazia. |
description | string | Sim | Conteúdo HTML do ticket. Suporta formatação HTML como <p>, <strong>, <em>, etc. |
email | string | Não | Endereço de e-mail do solicitante. |
requester_id | integer | Não | ID do usuário solicitante. |
phone | string | Não | Número de telefone do solicitante. |
name | string | Não | Nome do solicitante. |
status | string | Não | Status do ticket: open, pending, resolved ou closed. |
priority | string | Não | Prioridade do ticket: low, medium, high ou urgent. |
source | string | Não | Canal de origem do ticket: email, portal, phone, chat, feedback_widget ou outbound_email. |
group_id | integer | Não | ID do grupo ao qual o ticket foi atribuído. |
responder_id | integer | Não | ID do agente ao qual o ticket foi atribuído. |
company_id | integer | Não | ID da empresa do solicitante. |
tags | array | Não | Tags associadas ao ticket. |
due_by | string | Não | Prazo de resolução do ticket no formato ISO 8601 (ex.: 2026-01-30T15:00:00Z). |
fr_due_by | string | Não | Prazo para a primeira resposta no formato ISO 8601. |
cc_emails | array | Não | Endereços de e-mail adicionados no campo cc. |
custom_fields | object | Não | Pares chave-valor de campos personalizados (ex.: {"cf_campo": "valor"}). |
product_id | integer | Não | ID do produto vinculado ao ticket. |
twitter_id | string | Não | Handle do Twitter do solicitante. |
facebook_id | string | Não | ID do Facebook do solicitante. |
unique_external_id | string | Não | ID externo do solicitante. |
email_config_id | integer | Não | ID da configuração de e-mail utilizada para este ticket. |
attachments | array | Não | Anexos do ticket. Requerem formato multipart/form-data; não são suportados via JSON. |
| 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. |
Visualizar ticket
Seção intitulada “Visualizar ticket”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ticket_id | integer | Sim | ID do ticket a ser visualizado. |
include | string | Não | Lista 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). |
| 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”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página para paginação. |
per_page | integer | Não | Quantidade de tickets por página. |
filter | string | Não | Filtro predefinido: new_and_my_open, watching, spam, deleted, entre outros. |
status | string | Não | Filtrar por status: open, pending, resolved, closed, waiting_on_customer ou waiting_on_third_party. |
priority | string | Não | Filtrar por prioridade: low, medium, high ou urgent. |
agent_id | integer | Não | Filtrar tickets por ID do agente. |
group_id | integer | Não | Filtrar tickets por ID do grupo. |
requester_id | integer | Não | Filtrar tickets por ID do solicitante. |
sort_by | string | Não | Campo de ordenação, ex.: created_at. |
sort_order | string | Não | Direção da ordenação: asc ou desc. |
created_since | string | Não | Recuperar tickets criados desde esta data/hora no formato YYYY-MM-DDTHH:MM:SSZ. |
| 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”FRESHDESK_UPDATE_TICKET
Atualiza os atributos de um ticket existente no Freshdesk, como assunto, prioridade, status, descrição ou campos personalizados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ticket_id | integer | Sim | ID do ticket a ser atualizado. |
subject | string | Não | Assunto do ticket. |
description | string | Não | Conteúdo HTML da descrição do ticket. |
status | string | Não | Novo status: open, pending, resolved, closed, waiting_on_customer ou waiting_on_third_party. |
priority | string | Não | Nova prioridade: low, medium, high ou urgent. |
source | string | Não | Canal de origem. |
type | string | Não | Tipo do ticket (ex.: Question, Incident, Problem, Feature Request). Tipos personalizados do seu Freshdesk também são aceitos. |
group_id | integer | Não | ID do grupo ao qual o ticket está atribuído. |
responder_id | integer | Não | ID do agente ao qual o ticket está atribuído. |
company_id | integer | Não | ID da empresa associada ao solicitante. |
tags | array | Não | Tags a associar ao ticket. |
due_by | string | Não | Novo prazo de resolução no formato ISO 8601. |
fr_due_by | string | Não | Novo prazo para a primeira resposta no formato ISO 8601. |
parent_id | integer | Não | ID do ticket pai para vincular este ticket. |
custom_fields | object | Não | Campos personalizados (ex.: {"cf_reference_number": "REF-123"}). |
email | string | Não | E-mail do solicitante. |
name | string | Não | Nome do solicitante. |
phone | string | Não | Telefone do solicitante. |
requester_id | integer | Não | ID do solicitante. |
| 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. |
Excluir ticket
Seção intitulada “Excluir ticket”FRESHDESK_DELETE_TICKET
Exclui permanentemente um ticket do Freshdesk. Após a exclusão, o ticket não pode ser restaurado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ticket_id | integer | Sim | Identificador único do ticket a ser excluído. |
| 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. |
Responder ticket
Seção intitulada “Responder ticket”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ticket_id | integer | Sim | Identificador único do ticket a responder. |
body | string | Sim | Conteúdo da resposta. Pode conter formatação HTML. |
user_id | integer | Não | ID do agente que está criando a resposta. Use para responder em nome de outro usuário. |
from_email | string | Não | E-mail de suporte utilizado como remetente. Por padrão, usa o e-mail de origem do ticket. |
cc_emails | array | Não | Endereços de e-mail a incluir no campo cc. Máximo de 50 destinatários no total entre to/cc/bcc. |
bcc_emails | array | Não | Endereços de e-mail a incluir no campo bcc. |
to_emails | array | Não | Destinatários diretos, substituindo o solicitante padrão. Requer o recurso multiple_to habilitado na conta. |
| 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. |
Adicionar nota ao ticket
Seção intitulada “Adicionar nota ao ticket”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ticket_id | integer | Sim | Identificador único do ticket ao qual a nota será adicionada. |
body | string | Sim | Conteúdo da nota. Pode conter texto simples ou HTML. |
private | boolean | Não | Indica se a nota é privada (visível apenas para agentes). Padrão: true. |
user_id | integer | Não | ID do usuário que está criando a nota (útil para postar em nome de outro usuário). |
notify_emails | array | Não | Endereços de e-mail de agentes a notificar sobre a nota. Somente endereços de agentes são aceitos. |
| 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 tickets em massa
Seção intitulada “Atualizar tickets em massa”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ids | array | Sim | Array com os IDs dos tickets a atualizar em massa (ex.: [18, 17, 123]). |
properties | object | Sim | Objeto com os campos a atualizar e seus novos valores. Pelo menos uma propriedade deve ser especificada. |
| 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”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do contato. |
email | string | Não | Endereço de e-mail principal do contato. |
phone | string | Não | Número de telefone do contato. |
mobile | string | Não | Número de celular do contato. |
job_title | string | Não | Cargo do contato. |
company_id | integer | Não | ID da empresa principal associada a este contato. |
address | string | Não | Endereço físico do contato. |
description | string | Não | Notas ou descrição sobre o contato. |
tags | array | Não | Tags associadas ao contato. |
language | string | Não | Código do idioma preferido do contato. |
time_zone | string | Não | Fuso horário do contato. |
twitter_id | string | Não | Handle do Twitter do contato. |
other_emails | array | Não | Endereços de e-mail adicionais do contato. |
custom_fields | object | Sim | Campos personalizados. Os nomes das chaves não devem ter o prefixo cf_. |
view_all_tickets | boolean | Não | Se true, o contato pode visualizar todos os tickets da sua empresa. |
unique_external_id | string | Não | ID externo do contato para fins de integraçã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 contatos
Seção intitulada “Listar contatos”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página para paginação. Começa em 1. Padrão: 1. |
per_page | integer | Não | Quantidade de contatos por página. Máximo: 100. Padrão: 30. |
email | string | Não | Filtrar contatos por endereço de e-mail. |
phone | string | Não | Filtrar contatos por número de telefone (somente dígitos). |
mobile | string | Não | Filtrar contatos por número de celular (somente dígitos). |
state | string | Não | Filtrar contatos por estado. |
company_id | integer | Não | Filtrar contatos de uma empresa específica pelo ID da empresa. |
updated_since | string | Não | Recuperar contatos modificados após a data/hora especificada no formato ISO 8601. |
| 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 contato
Seção intitulada “Obter contato”FRESHDESK_GET_CONTACT
Recupera as informações detalhadas de um contato específico pelo ID.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | integer | Sim | Identificador único do contato a recuperar. |
| 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”FRESHDESK_UPDATE_CONTACT
Atualiza as informações de um contato existente no Freshdesk, como nome, e-mail, telefone, cargo ou campos personalizados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do contato a atualizar. |
name | string | Não | Nome atualizado do contato. |
email | string | Não | Endereço de e-mail atualizado. |
phone | string | Não | Número de telefone atualizado. |
mobile | string | Não | Número de celular atualizado. |
job_title | string | Não | Cargo atualizado. |
company_id | integer | Não | ID da empresa principal atualizado. |
address | string | Não | Endereço físico atualizado. |
description | string | Não | Notas ou descrição atualizadas. |
tags | array | Não | Tags atualizadas. |
language | string | Não | Código de idioma atualizado. |
time_zone | string | Não | Fuso horário atualizado. |
twitter_id | string | Não | Handle do Twitter atualizado. |
other_emails | array | Não | Endereços de e-mail adicionais atualizados. |
custom_fields | object | Não | Campos personalizados atualizados. |
view_all_tickets | boolean | Não | Se true, o contato pode visualizar todos os tickets da empresa. |
unique_external_id | string | Não | ID externo atualizado. |
| 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. |
Excluir contato
Seção intitulada “Excluir contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | integer | Sim | Identificador único do contato a ser excluído suavemente. |
| 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
Seção intitulada “Buscar contatos”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Sim | String 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. |
page | integer | Não | Nú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. |
| 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”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da empresa. |
domains | array | Não | Array de domínios associados à empresa. O Freshdesk associa contatos automaticamente se o e-mail contiver um dos domínios especificados. |
description | string | Não | Descrição sobre a empresa. |
note | string | Não | Notas adicionais sobre a empresa. |
industry | string | Não | Classificação do setor (disponível no plano Blossom e superiores). |
account_tier | string | Não | Nível da conta: Basic, Premium ou Enterprise. |
health_score | string | Não | Pontuação de saúde: Happy, Doing okay ou At risk. |
renewal_date | string | Não | Data de renovação do contrato no formato YYYY-MM-DD. |
custom_fields | object | Não | Campos personalizados da empresa. As chaves não levam o prefixo cf_. |
| 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”FRESHDESK_GET_COMPANIES
Recupera todas as empresas de uma conta Freshdesk com suporte a paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página para paginação. Começa em 1. Padrão: 1. |
per_page | integer | Não | Quantidade de empresas por página. Máximo: 100. Padrão: 30. |
| 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”FRESHDESK_GET_COMPANY
Recupera as informações detalhadas de uma empresa específica pelo ID, incluindo domínios e campos personalizados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
company_id | integer | Sim | Identificador único da empresa a recuperar. |
| 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. |
Excluir empresa
Seção intitulada “Excluir empresa”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
company_id | integer | Sim | Identificador único da empresa a excluir. |
| 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 (autocompletar)
Seção intitulada “Buscar empresas (autocompletar)”FRESHDESK_SEARCH_COMPANY
Busca empresas por nome ou nome parcial usando a funcionalidade de autocompletar do Freshdesk.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome ou nome parcial da empresa a buscar. |
| 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 agente
Seção intitulada “Obter agente”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
agent_id | integer | Sim | Identificador único do agente a recuperar. |
| 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 agentes
Seção intitulada “Buscar agentes”FRESHDESK_SEARCH_AGENTS
Busca e filtra agentes no Freshdesk por e-mail, telefone, celular ou tipo (integral/eventual).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | Não | Filtrar agentes por endereço de e-mail. |
phone | string | Não | Filtrar agentes por número de telefone. |
mobile | string | Não | Filtrar agentes por número de celular. |
state | string | Não | Filtrar agentes pelo tipo: fulltime (integral) ou occasional (eventual). |
page | integer | Não | Número da página de resultados. |
per_page | integer | Não | Quantidade de resultados por página. |
| 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 artigo de solução
Seção intitulada “Criar artigo de solução”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
folder_id | integer | Sim | Identificador único da pasta onde o artigo será criado. |
title | string | Sim | Título do artigo de solução. |
description | string | Sim | Conteúdo do artigo em formato HTML. |
status | string | Não | Status de publicação: draft (rascunho) ou published (publicado). |
agent_id | integer | Não | ID do agente criando o artigo. Por padrão, usa o agente autenticado. |
tags | array | Não | Tags para categorizar o artigo. |
seo_data | object | Não | Dados de SEO para o artigo. |
| 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 artigos de solução
Seção intitulada “Listar artigos de solução”FRESHDESK_LIST_SOLUTION_ARTICLES
Recupera todos os artigos de solução dentro de uma pasta especificada no Freshdesk.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
folder_id | integer | Sim | Identificador único da pasta de soluções da qual recuperar artigos. |
page | integer | Não | Número da página para paginação. Cada página retorna até 30 artigos. |
| 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. |