Freshservice (Pré-visualização)
O Freshservice é uma solução de gerenciamento de serviços e service desk de TI baseada em nuvem que é fácil de configurar e usar para transformar a experiência dos funcionários em toda a organização.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte ao aplicativo Freshworks |
| URL | https://www.freshworks.com |
| appsupport-ex@freshworks.com |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | https://www.freshworks.com/freshservice/lp/home/ |
| Política de privacidade | https://www.freshworks.com/privacy |
| Categorias | Operações de TI |
Authentication
Importante
A autenticação baseada em nome de usuário e senha não tem mais suporte do FreshService. O conector agora dá suporte a apenas um tipo de autenticação – Chave de API. Documentos de Migração de API do FreshService
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Chave de API | Tipo de autenticação de chave de API | Todas as regiões | Não compartilhável |
| Padrão [PRETERIDO] | Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores. | Todas as regiões | Não compartilhável |
Chave de API
ID de autenticação: Básico
Aplicável: todas as regiões
Tipo de autenticação de chave de API
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | cadeia | A chave de API para esta api | Verdade |
| URL do site | cadeia | URL do site raiz (exemplo: https://sample.freshservice.com ) | Verdade |
Padrão [PRETERIDO]
Aplicável: todas as regiões
Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome de usuário | cadeia | O nome de usuário para esta api | Verdade |
| Senha | secureString | A senha dessa api | Verdade |
| URL do site | cadeia | URL do site raiz (exemplo: https://sample.freshservice.com ) | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
| Frequência das pesquisas de gatilho | 1 | 120 segundos |
Ações
| Adicionar uma anotação a um tíquete (V2) |
Adicione uma nota privada ou pública a um tíquete. |
| Adicionar uma anotação a um tíquete [PRETERIDO] |
Adicione uma nota privada ou pública a um tíquete. |
| Atualizar um tíquete (V2) |
Atualize um tíquete (somente valores especificados serão atualizados). |
| Atualizar um tíquete [PRETERIDO] |
Atualize um tíquete (somente valores especificados serão atualizados). |
| Criar um tíquete (V2) |
Crie um tíquete. |
| Criar um tíquete [PRETERIDO] |
Crie um tíquete. |
Adicionar uma anotação a um tíquete (V2)
Adicione uma nota privada ou pública a um tíquete.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tíquete
|
ticketId | True | integer |
A ID do tíquete a ser atualizada. |
|
Observação
|
body | True | string |
A nota a ser adicionada ao tíquete. |
|
É privado
|
private | boolean |
Defina como true se a mensagem for privada. |
Retornos
- Corpo
- AddNote_ResponseV2
Adicionar uma anotação a um tíquete [PRETERIDO]
Adicione uma nota privada ou pública a um tíquete.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tíquete
|
ticketId | True | integer |
A ID do tíquete a ser atualizada. |
|
Observação
|
body | True | string |
A nota a ser adicionada ao tíquete. |
|
É privado
|
private | boolean |
Defina como true se a mensagem for privada. |
Retornos
- Corpo
- AddNote_Response
Atualizar um tíquete (V2)
Atualize um tíquete (somente valores especificados serão atualizados).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tíquete
|
ticketId | True | integer |
A ID do tíquete a ser atualizada. |
|
ID do solicitante
|
requester_id | integer |
ID do usuário do solicitante. Para contatos existentes, requester_id pode ser passado em vez de email. |
|
|
Assunto
|
subject | string |
O assunto do tíquete. |
|
|
Situação
|
status | string |
Status do tíquete. |
|
|
Priority
|
priority | string |
A prioridade do tíquete (como Baixo, Médio ou Alto). |
|
|
Urgência
|
urgency | string |
Urgência do problema (como Baixo, Médio ou Alto). |
|
|
Impacto
|
impact | string |
Impacto do problema (como Baixo, Médio ou Alto). |
|
|
Source
|
source | string |
O canal pelo qual o tíquete foi criado. |
Retornos
Atualizar um tíquete [PRETERIDO]
Atualize um tíquete (somente valores especificados serão atualizados).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tíquete
|
ticketId | True | integer |
A ID do tíquete a ser atualizada. |
|
ID do solicitante
|
requester_id | integer |
ID do usuário do solicitante. Para contatos existentes, requester_id pode ser passado em vez de email. |
|
|
Assunto
|
subject | string |
O assunto do tíquete. |
|
|
Situação
|
status | string |
Status do tíquete. |
|
|
Priority
|
priority | string |
A prioridade do tíquete (como Baixo, Médio ou Alto). |
|
|
Urgência
|
urgency | string |
Urgência do problema (como Baixo, Médio ou Alto). |
|
|
Impacto
|
impact | string |
Impacto do problema (como Baixo, Médio ou Alto). |
|
|
Source
|
source | string |
O canal pelo qual o tíquete foi criado. |
Retornos
- Corpo
- UpdateTicket_Response
Criar um tíquete (V2)
Crie um tíquete.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do solicitante
|
requester_id | integer |
ID do usuário do solicitante. Uma das IDs do solicitante, o email do solicitante e o telefone solicitante são necessários |
|
|
Email do solicitante
|
string |
Email do solicitante. Uma das IDs do solicitante, o email do solicitante e o telefone solicitante são necessários |
||
|
Telefone solicitante
|
phone | string |
Número de telefone do solicitante. Uma das IDs do solicitante, o email do solicitante e o telefone solicitante são necessários |
|
|
Nome do solicitante
|
name | string |
Nome do solicitante. Esse é um campo necessário somente se o valor do Telefone Solicitante for fornecido |
|
|
Assunto
|
subject | True | string |
O assunto do tíquete. |
|
Situação
|
status | True | string |
Status do tíquete. |
|
Priority
|
priority | True | string |
A prioridade do tíquete (como Baixo, Médio ou Alto). |
|
Description
|
description | True | string |
A descrição do tíquete. |
|
Urgência
|
urgency | string |
Urgência do problema (como Baixo, Médio ou Alto). |
|
|
Impacto
|
impact | string |
Impacto do problema (como Baixo, Médio ou Alto). |
|
|
Source
|
source | string |
O canal pelo qual o tíquete foi criado. |
Retornos
Criar um tíquete [PRETERIDO]
Crie um tíquete.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do solicitante
|
requester_id | True | integer |
ID do usuário do solicitante. Para contatos existentes, requester_id pode ser passado em vez de email. |
|
Assunto
|
subject | True | string |
O assunto do tíquete. |
|
Situação
|
status | True | string |
Status do tíquete. |
|
Priority
|
priority | True | string |
A prioridade do tíquete (como Baixo, Médio ou Alto). |
|
Description
|
description | True | string |
A descrição do tíquete. |
|
Urgência
|
urgency | string |
Urgência do problema (como Baixo, Médio ou Alto). |
|
|
Impacto
|
impact | string |
Impacto do problema (como Baixo, Médio ou Alto). |
|
|
Source
|
source | string |
O canal pelo qual o tíquete foi criado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
helpdesk_ticket
|
item.helpdesk_ticket | Ticket_Response |
Gatilhos
| Quando um tíquete é criado (V2) |
Dispara quando um novo tíquete é criado. |
| Quando um tíquete é criado [PRETERIDO] |
Dispara quando um novo tíquete é criado. |
Quando um tíquete é criado (V2)
Quando um tíquete é criado [PRETERIDO]
Definições
Ticket_Response
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
created_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Está Excluído
|
deleted | boolean |
Defina como true se o tíquete for excluído/destruído. Os tíquetes excluídos não serão considerados em nenhuma exibição, exceto no filtro 'excluído'. |
|
ID do departamento
|
department_id_value | integer | |
|
ID do tíquete
|
display_id | integer |
ID do tíquete específica para sua conta. |
|
Conclusão por Date-Time
|
due_by | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
ID do grupo
|
group_id | integer |
ID do Grupo ao qual o tíquete é atribuído. |
|
ID
|
id | integer |
ID exclusiva do tíquete. |
|
Impacto
|
impact | integer |
Um número que representa o impacto do problema. |
|
Foi Escalonado
|
isescalated | boolean |
Definido como true se um escalonamento foi enviado. |
|
ID do proprietário
|
owner_id | string |
ID do agente ao qual o problema é atribuído. |
|
Priority
|
priority | integer |
Um número que representa a prioridade do tíquete. |
|
ID do solicitante
|
requester_id | integer |
ID do usuário do solicitante. Para contatos existentes, requester_id pode ser passado em vez de email. |
|
ID do respondente
|
responder_id | integer |
Id do agente ao qual o tíquete é atribuído. |
|
Source
|
source | integer |
Um número que representa o canal pelo qual o tíquete foi criado. |
|
Spam
|
spam | boolean |
Defina como true se o tíquete estiver marcado como spam. |
|
Situação
|
status | integer |
Um número que representa o status do tíquete. |
|
Assunto
|
subject | string |
Assunto do tíquete. |
|
Tipo de tíquete
|
ticket_type | string |
Digite o campo de propriedade conforme definido em campos de tíquete. |
|
Para Email
|
to_email | string |
Endereço de email para o qual o email do tíquete de entrada foi enviado. |
|
Atualizado em Date-Time
|
updated_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Urgência
|
urgency | integer |
Um número que representa a urgência do problema. |
|
Description
|
description | string |
Descrição do problema. |
|
HTML de descrição
|
description_html | string |
Conteúdo HTML do tíquete. A descrição e description_html não devem ser passadas juntas. |
|
Nome do Status
|
status_name | string |
Status do tíquete. |
|
Nome da prioridade
|
priority_name | string |
Prioridade do tíquete. |
|
Nome da origem
|
source_name | string |
O canal pelo qual o tíquete foi criado. |
|
Nome do respondente
|
responder_name | string |
Nome do agente ao qual o tíquete é atribuído. |
|
Para Emails
|
to_emails | array of string |
Endereços de email para os quais o email do tíquete de entrada foi enviado. |
|
Nome do departamento
|
department_name | string |
Nome do departamento. |
|
ID do problema associado
|
assoc_problem_id | integer |
ID do problema associado ao tíquete. |
|
ID de alteração associada
|
assoc_change_id | integer |
ID da alteração associada ao problema. |
|
ID da Causa de Alteração Associada
|
assoc_change_cause_id | integer |
ID da alteração causando o tíquete. |
|
ID do ativo associado
|
assoc_asset_id | integer |
ID do ativo associado ao tíquete. |
|
Nome da urgência
|
urgency_name | string |
Urgência do problema. |
|
Nome do impacto
|
impact_name | string |
Impacto do problema. |
CreateUpdateTicket_ResponseV2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
ticket.created_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
ID do departamento
|
ticket.department_id | integer | |
|
Conclusão por Date-Time
|
ticket.due_by | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
ID do grupo
|
ticket.group_id | integer |
ID do Grupo ao qual o tíquete é atribuído. |
|
ID
|
ticket.id | integer |
ID exclusiva do tíquete. |
|
Foi Escalonado
|
ticket.is_escalated | boolean |
Definido como true se um escalonamento foi enviado. |
|
Priority
|
ticket.priority | integer |
Um número que representa a prioridade do tíquete. |
|
ID do solicitante
|
ticket.requester_id | integer |
ID do usuário do solicitante. Para contatos existentes, requester_id pode ser passado em vez de email. |
|
ID do respondente
|
ticket.responder_id | integer |
Id do agente ao qual o tíquete é atribuído. |
|
Source
|
ticket.source | integer |
Um número que representa o canal pelo qual o tíquete foi criado. |
|
Spam
|
ticket.spam | boolean |
Defina como true se o tíquete estiver marcado como spam. |
|
Situação
|
ticket.status | integer |
Um número que representa o status do tíquete. |
|
Assunto
|
ticket.subject | string |
Assunto do tíquete. |
|
Tipo de tíquete
|
ticket.type | string |
Digite o campo de propriedade conforme definido em campos de tíquete. |
|
Atualizado em Date-Time
|
ticket.updated_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Description
|
ticket.description_text | string |
Descrição do problema. |
|
HTML de descrição
|
ticket.description | string |
Conteúdo HTML do tíquete. A descrição e description_html não devem ser passadas juntas. |
|
Para Emails
|
ticket.to_emails | array of string |
Endereços de email para os quais o email do tíquete de entrada foi enviado. |
ListTicket_ResponseV2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
created_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
ID do departamento
|
department_id | integer | |
|
Conclusão por Date-Time
|
due_by | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
ID do grupo
|
group_id | integer |
ID do Grupo ao qual o tíquete é atribuído. |
|
ID
|
id | integer |
ID exclusiva do tíquete. |
|
Foi Escalonado
|
is_escalated | boolean |
Definido como true se um escalonamento foi enviado. |
|
Priority
|
priority | integer |
Um número que representa a prioridade do tíquete. |
|
ID do solicitante
|
requester_id | integer |
ID do usuário do solicitante. Para contatos existentes, requester_id pode ser passado em vez de email. |
|
ID do respondente
|
responder_id | integer |
Id do agente ao qual o tíquete é atribuído. |
|
Source
|
source | integer |
Um número que representa o canal pelo qual o tíquete foi criado. |
|
Spam
|
spam | boolean |
Defina como true se o tíquete estiver marcado como spam. |
|
Situação
|
status | integer |
Um número que representa o status do tíquete. |
|
Assunto
|
subject | string |
Assunto do tíquete. |
|
Tipo de tíquete
|
type | string |
Digite o campo de propriedade conforme definido em campos de tíquete. |
|
Atualizado em Date-Time
|
updated_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Description
|
description_text | string |
Descrição do problema. |
|
HTML de descrição
|
description | string |
Conteúdo HTML do tíquete. A descrição e description_html não devem ser passadas juntas. |
|
Para Emails
|
to_emails | array of string |
Endereços de email para os quais o email do tíquete de entrada foi enviado. |
UpdateTicket_Response
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Está Excluído
|
ticket.deleted | boolean |
Defina como true se o tíquete for excluído/destruído. Os tíquetes excluídos não serão considerados em nenhuma exibição, exceto no filtro 'excluído'. |
|
ID do tíquete
|
ticket.display_id | integer |
ID do tíquete específica para sua conta. |
|
Assunto
|
ticket.subject | string |
Assunto do tíquete. |
|
Description
|
ticket.description | string |
Descrição do tíquete. |
|
HTML de descrição
|
ticket.description_html | string |
Conteúdo HTML do tíquete. A descrição e description_html não devem ser passadas juntas. |
|
Nome do Status
|
ticket.status_name | string |
Status do tíquete. |
|
Nome da prioridade
|
ticket.priority_name | string |
Prioridade do tíquete. |
|
Nome da origem
|
ticket.source_name | string |
O canal pelo qual o tíquete foi criado. |
|
Nome do respondente
|
ticket.responder_name | string |
Nome do agente ao qual o tíquete é atribuído. |
|
Para Emails
|
ticket.to_emails | array of string |
Endereços de email para os quais o email do tíquete de entrada foi enviado. |
|
Nome do departamento
|
ticket.department_name | string |
Nome do departamento. |
|
ID do problema associado
|
ticket.assoc_problem_id | integer |
ID do problema associado ao tíquete. |
|
ID de alteração associada
|
ticket.assoc_change_id | integer |
ID da alteração associada ao problema. |
|
ID da Causa de Alteração Associada
|
ticket.assoc_change_cause_id | integer |
ID da alteração causando o tíquete. |
|
ID do ativo associado
|
ticket.assoc_asset_id | integer |
ID do ativo associado ao tíquete. |
|
Nome da urgência
|
ticket.urgency_name | string |
Urgência do problema. |
|
Nome do impacto
|
ticket.impact_name | string |
Impacto do problema. |
AddNote_Response
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
note.created_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Está Excluído
|
note.deleted | boolean |
Defina como true se o tíquete for excluído/destruído. Os tíquetes excluídos não serão considerados em nenhuma exibição, exceto no filtro 'excluído'. |
|
ID
|
note.id | integer |
ID exclusiva da anotação. |
|
Privado
|
note.private | boolean |
Defina como true se a nota for privada. |
|
Source
|
note.source | integer |
Um número que representa o canal pelo qual o tíquete foi criado. |
|
Atualizado em Date-Time
|
note.updated_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Identificação de usuário
|
note.user_id | integer |
User_id do agente que está adicionando a anotação. |
|
Corpo
|
note.body | string |
Conteúdo da anotação em texto sem formatação. |
|
HTML do corpo
|
note.body_html | string |
Conteúdo da anotação no formato HTML. O corpo ou body_html tem que ser passado. |
|
attachments
|
note.attachments | array of string |
AddNote_ResponseV2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
conversation.created_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
ID
|
conversation.id | integer |
ID exclusiva da anotação. |
|
Privado
|
conversation.private | boolean |
Defina como true se a nota for privada. |
|
Atualizado em Date-Time
|
conversation.updated_at | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Identificação de usuário
|
conversation.user_id | integer |
User_id do agente que está adicionando a anotação. |
|
Corpo
|
conversation.body_text | string |
Conteúdo da anotação em texto sem formatação. |
|
HTML do corpo
|
conversation.body | string |
Conteúdo da anotação no formato HTML. O corpo ou body_html tem que ser passado. |
|
attachments
|
conversation.attachments | array of string | |
|
ID do tíquete
|
conversation.ticket_id | integer |
ID exclusiva do tíquete. |