Freshservice (Pré-visualização)
O Freshservice é uma central de serviços de TI baseada em nuvem e uma solução de gerenciamento de serviços que é fácil de configurar e usar, para transformar a experiência dos funcionários em toda a organização.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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 | |
|---|---|
| Editora | Microsoft |
| Sítio Web | 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 é mais suportada pelo FreshService. O conector agora suporta apenas um tipo de autenticação - API Key. Documentos de migração da API do FreshService
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Chave da API | Tipo de autenticação de chave de API | Todas as regiões | Não compartilhável |
| Padrão [DEPRECATED] | Esta 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
Auth ID: Básico
Aplicável: Todas as regiões
Tipo de autenticação de chave de API
Esta conexão não é compartilhável. Se o aplicativo avançado 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 (de caracteres) | A chave de API para esta api | Verdade |
| URL do site | cadeia (de caracteres) | URL do site raiz (exemplo: https://sample.freshservice.com ) | Verdade |
Padrão [DEPRECATED]
Aplicável: Todas as regiões
Esta 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.
Esta conexão não é compartilhável. Se o aplicativo avançado 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 utilizador | cadeia (de caracteres) | O nome de usuário para esta api | Verdade |
| Palavra-passe | securestring | A senha para esta api | Verdade |
| URL do site | cadeia (de caracteres) | URL do site raiz (exemplo: https://sample.freshservice.com ) | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
| Frequência das sondagens de desencadeamento | 1 | 120 segundos |
Ações
| Adicionar uma nota a um bilhete (V2) |
Adicione uma nota pública ou privada a um bilhete. |
| Adicionar uma nota a um bilhete [DEPRECATED] |
Adicione uma nota pública ou privada a um bilhete. |
| Atualizar um ticket (V2) |
Atualize um ticket (apenas os valores especificados serão atualizados). |
| Atualizar um ticket [DEPRECATED] |
Atualize um ticket (apenas os valores especificados serão atualizados). |
| Criar um ticket (V2) |
Crie um ticket. |
| Criar um ticket [DEPRECATED] |
Crie um ticket. |
Adicionar uma nota a um bilhete (V2)
Adicione uma nota pública ou privada a um bilhete.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do bilhete
|
ticketId | True | integer |
O ID do ticket a ser atualizado. |
|
Observação
|
body | True | string |
A nota a ser adicionada ao bilhete. |
|
É privado
|
private | boolean |
Defina como true se a mensagem for privada. |
Devoluções
- Body
- AddNote_ResponseV2
Adicionar uma nota a um bilhete [DEPRECATED]
Adicione uma nota pública ou privada a um bilhete.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do bilhete
|
ticketId | True | integer |
O ID do ticket a ser atualizado. |
|
Observação
|
body | True | string |
A nota a ser adicionada ao bilhete. |
|
É privado
|
private | boolean |
Defina como true se a mensagem for privada. |
Devoluções
- Body
- AddNote_Response
Atualizar um ticket (V2)
Atualize um ticket (apenas os valores especificados serão atualizados).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do bilhete
|
ticketId | True | integer |
O ID do ticket a ser atualizado. |
|
ID do solicitante
|
requester_id | integer |
ID de usuário do solicitante. Para contatos existentes, requester_id podem ser passados em vez de e-mail. |
|
|
Assunto
|
subject | string |
O assunto do bilhete. |
|
|
Situação
|
status | string |
Estado do bilhete. |
|
|
Priority
|
priority | string |
A prioridade do bilhete (como Baixa, Média ou Alta). |
|
|
Urgência
|
urgency | string |
Urgência do problema (como Baixa, Média ou Alta). |
|
|
Impacto
|
impact | string |
Impacto do problema (como Baixo, Médio ou Alto). |
|
|
Fonte
|
source | string |
O canal através do qual o bilhete foi criado. |
Devoluções
Atualizar um ticket [DEPRECATED]
Atualize um ticket (apenas os valores especificados serão atualizados).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do bilhete
|
ticketId | True | integer |
O ID do ticket a ser atualizado. |
|
ID do solicitante
|
requester_id | integer |
ID de usuário do solicitante. Para contatos existentes, requester_id podem ser passados em vez de e-mail. |
|
|
Assunto
|
subject | string |
O assunto do bilhete. |
|
|
Situação
|
status | string |
Estado do bilhete. |
|
|
Priority
|
priority | string |
A prioridade do bilhete (como Baixa, Média ou Alta). |
|
|
Urgência
|
urgency | string |
Urgência do problema (como Baixa, Média ou Alta). |
|
|
Impacto
|
impact | string |
Impacto do problema (como Baixo, Médio ou Alto). |
|
|
Fonte
|
source | string |
O canal através do qual o bilhete foi criado. |
Devoluções
Criar um ticket (V2)
Crie um ticket.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do solicitante
|
requester_id | integer |
ID de usuário do solicitante. É necessário um dos ID do Solicitante, E-mail do Solicitante e Telefone do Solicitante |
|
|
E-mail do solicitante
|
string |
E-mail do solicitante. É necessário um dos ID do Solicitante, E-mail do Solicitante e Telefone do Solicitante |
||
|
Telefone do solicitante
|
phone | string |
Número de telefone do solicitante. É necessário um dos ID do Solicitante, E-mail do Solicitante e Telefone do Solicitante |
|
|
Nome do solicitante
|
name | string |
Nome do requerente. Este é um campo obrigatório somente se o valor Telefone do solicitante for fornecido |
|
|
Assunto
|
subject | True | string |
O assunto do bilhete. |
|
Situação
|
status | True | string |
Estado do bilhete. |
|
Priority
|
priority | True | string |
A prioridade do bilhete (como Baixa, Média ou Alta). |
|
Description
|
description | True | string |
A descrição do bilhete. |
|
Urgência
|
urgency | string |
Urgência do problema (como Baixa, Média ou Alta). |
|
|
Impacto
|
impact | string |
Impacto do problema (como Baixo, Médio ou Alto). |
|
|
Fonte
|
source | string |
O canal através do qual o bilhete foi criado. |
Devoluções
Criar um ticket [DEPRECATED]
Crie um ticket.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do solicitante
|
requester_id | True | integer |
ID de usuário do solicitante. Para contatos existentes, requester_id podem ser passados em vez de e-mail. |
|
Assunto
|
subject | True | string |
O assunto do bilhete. |
|
Situação
|
status | True | string |
Estado do bilhete. |
|
Priority
|
priority | True | string |
A prioridade do bilhete (como Baixa, Média ou Alta). |
|
Description
|
description | True | string |
A descrição do bilhete. |
|
Urgência
|
urgency | string |
Urgência do problema (como Baixa, Média ou Alta). |
|
|
Impacto
|
impact | string |
Impacto do problema (como Baixo, Médio ou Alto). |
|
|
Fonte
|
source | string |
O canal através do qual o bilhete foi criado. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
helpdesk_ticket
|
item.helpdesk_ticket | Ticket_Response |
Acionadores
| Quando um ticket é criado (V2) |
Aciona quando um novo tíquete é criado. |
| Quando um ticket é criado [DEPRECATED] |
Aciona quando um novo tíquete é criado. |
Quando um ticket é criado (V2)
Quando um ticket é criado [DEPRECATED]
Definições
Ticket_Response
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
created_at | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
É suprimido
|
deleted | boolean |
Defina como true se o ticket for excluído/descartado. Os bilhetes eliminados não serão considerados em nenhuma vista, exceto no filtro 'eliminado'. |
|
Identificação do Departamento
|
department_id_value | integer | |
|
ID do bilhete
|
display_id | integer |
ID do bilhete específico para a sua conta. |
|
Vencimento até Date-Time
|
due_by | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
ID do Grupo
|
group_id | integer |
Id do Grupo ao qual o bilhete está atribuído. |
|
Id
|
id | integer |
Identificação única do bilhete. |
|
Impacto
|
impact | integer |
Um número que representa o impacto do problema. |
|
É Escalado
|
isescalated | boolean |
Defina como true se um escalonamento foi enviado. |
|
ID do proprietário
|
owner_id | string |
Id do agente a quem o problema é atribuído. |
|
Priority
|
priority | integer |
Um número que representa a prioridade do bilhete. |
|
ID do solicitante
|
requester_id | integer |
ID de usuário do solicitante. Para contatos existentes, requester_id podem ser passados em vez de e-mail. |
|
ID do Respondente
|
responder_id | integer |
Identificação do agente a quem o bilhete é atribuído. |
|
Fonte
|
source | integer |
Um número que representa o canal através do qual o bilhete foi criado. |
|
Spam (correio não solicitado)
|
spam | boolean |
Defina como true se o ticket estiver marcado como spam. |
|
Situação
|
status | integer |
Um número que representa o status do bilhete. |
|
Assunto
|
subject | string |
Assunto do bilhete. |
|
Tipo de Bilhete
|
ticket_type | string |
Digite o campo de propriedade conforme definido nos campos de tíquete. |
|
Para enviar por e-mail
|
to_email | string |
Endereço de e-mail para o qual o e-mail de entrada do bilhete foi enviado. |
|
Atualizado em Date-Time
|
updated_at | date-time |
aaaa-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. |
|
Descrição HTML
|
description_html | string |
Conteúdo HTML do bilhete. Descrição e description_html não devem ser passadas juntas. |
|
Nome do estado
|
status_name | string |
Estado do bilhete. |
|
Nome da prioridade
|
priority_name | string |
Prioridade do bilhete. |
|
Nome da fonte
|
source_name | string |
O canal através do qual o bilhete foi criado. |
|
Nome do respondente
|
responder_name | string |
Nome do agente a quem o bilhete é atribuído. |
|
Para e-mails
|
to_emails | array of string |
Endereços de e-mail para os quais o e-mail de entrada do ticket foi enviado. |
|
Nome do departamento
|
department_name | string |
Nome do departamento. |
|
ID do problema associado
|
assoc_problem_id | integer |
Id do problema associado ao bilhete. |
|
ID de alteração associado
|
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 que causou o bilhete. |
|
ID do ativo associado
|
assoc_asset_id | integer |
ID do ativo associado ao bilhete. |
|
Nome da urgência
|
urgency_name | string |
Urgência do problema. |
|
Nome do impacto
|
impact_name | string |
Impacto do problema. |
CreateUpdateTicket_ResponseV2
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
ticket.created_at | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Identificação do Departamento
|
ticket.department_id | integer | |
|
Vencimento até Date-Time
|
ticket.due_by | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
ID do Grupo
|
ticket.group_id | integer |
Id do Grupo ao qual o bilhete está atribuído. |
|
Id
|
ticket.id | integer |
Identificação única do bilhete. |
|
É Escalado
|
ticket.is_escalated | boolean |
Defina como true se um escalonamento foi enviado. |
|
Priority
|
ticket.priority | integer |
Um número que representa a prioridade do bilhete. |
|
ID do solicitante
|
ticket.requester_id | integer |
ID de usuário do solicitante. Para contatos existentes, requester_id podem ser passados em vez de e-mail. |
|
ID do Respondente
|
ticket.responder_id | integer |
Identificação do agente a quem o bilhete é atribuído. |
|
Fonte
|
ticket.source | integer |
Um número que representa o canal através do qual o bilhete foi criado. |
|
Spam (correio não solicitado)
|
ticket.spam | boolean |
Defina como true se o ticket estiver marcado como spam. |
|
Situação
|
ticket.status | integer |
Um número que representa o status do bilhete. |
|
Assunto
|
ticket.subject | string |
Assunto do bilhete. |
|
Tipo de Bilhete
|
ticket.type | string |
Digite o campo de propriedade conforme definido nos campos de tíquete. |
|
Atualizado em Date-Time
|
ticket.updated_at | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Description
|
ticket.description_text | string |
Descrição do problema. |
|
Descrição HTML
|
ticket.description | string |
Conteúdo HTML do bilhete. Descrição e description_html não devem ser passadas juntas. |
|
Para e-mails
|
ticket.to_emails | array of string |
Endereços de e-mail para os quais o e-mail de entrada do ticket foi enviado. |
ListTicket_ResponseV2
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
created_at | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Identificação do Departamento
|
department_id | integer | |
|
Vencimento até Date-Time
|
due_by | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
ID do Grupo
|
group_id | integer |
Id do Grupo ao qual o bilhete está atribuído. |
|
Id
|
id | integer |
Identificação única do bilhete. |
|
É Escalado
|
is_escalated | boolean |
Defina como true se um escalonamento foi enviado. |
|
Priority
|
priority | integer |
Um número que representa a prioridade do bilhete. |
|
ID do solicitante
|
requester_id | integer |
ID de usuário do solicitante. Para contatos existentes, requester_id podem ser passados em vez de e-mail. |
|
ID do Respondente
|
responder_id | integer |
Identificação do agente a quem o bilhete é atribuído. |
|
Fonte
|
source | integer |
Um número que representa o canal através do qual o bilhete foi criado. |
|
Spam (correio não solicitado)
|
spam | boolean |
Defina como true se o ticket estiver marcado como spam. |
|
Situação
|
status | integer |
Um número que representa o status do bilhete. |
|
Assunto
|
subject | string |
Assunto do bilhete. |
|
Tipo de Bilhete
|
type | string |
Digite o campo de propriedade conforme definido nos campos de tíquete. |
|
Atualizado em Date-Time
|
updated_at | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Description
|
description_text | string |
Descrição do problema. |
|
Descrição HTML
|
description | string |
Conteúdo HTML do bilhete. Descrição e description_html não devem ser passadas juntas. |
|
Para e-mails
|
to_emails | array of string |
Endereços de e-mail para os quais o e-mail de entrada do ticket foi enviado. |
UpdateTicket_Response
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
É suprimido
|
ticket.deleted | boolean |
Defina como true se o ticket for excluído/descartado. Os bilhetes eliminados não serão considerados em nenhuma vista, exceto no filtro 'eliminado'. |
|
ID do bilhete
|
ticket.display_id | integer |
ID do bilhete específico para a sua conta. |
|
Assunto
|
ticket.subject | string |
Assunto do bilhete. |
|
Description
|
ticket.description | string |
Descrição do bilhete. |
|
Descrição HTML
|
ticket.description_html | string |
Conteúdo HTML do bilhete. Descrição e description_html não devem ser passadas juntas. |
|
Nome do estado
|
ticket.status_name | string |
Estado do bilhete. |
|
Nome da prioridade
|
ticket.priority_name | string |
Prioridade do bilhete. |
|
Nome da fonte
|
ticket.source_name | string |
O canal através do qual o bilhete foi criado. |
|
Nome do respondente
|
ticket.responder_name | string |
Nome do agente a quem o bilhete é atribuído. |
|
Para e-mails
|
ticket.to_emails | array of string |
Endereços de e-mail para os quais o e-mail de entrada do ticket 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 bilhete. |
|
ID de alteração associado
|
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 que causou o bilhete. |
|
ID do ativo associado
|
ticket.assoc_asset_id | integer |
ID do ativo associado ao bilhete. |
|
Nome da urgência
|
ticket.urgency_name | string |
Urgência do problema. |
|
Nome do impacto
|
ticket.impact_name | string |
Impacto do problema. |
AddNote_Response
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
note.created_at | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
É suprimido
|
note.deleted | boolean |
Defina como true se o ticket for excluído/descartado. Os bilhetes eliminados não serão considerados em nenhuma vista, exceto no filtro 'eliminado'. |
|
Id
|
note.id | integer |
ID único da nota. |
|
Privado
|
note.private | boolean |
Defina como true se a nota for privada. |
|
Fonte
|
note.source | integer |
Um número que representa o canal através do qual o bilhete foi criado. |
|
Atualizado em Date-Time
|
note.updated_at | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
ID de Utilizador
|
note.user_id | integer |
User_id do agente que está adicionando a nota. |
|
Body
|
note.body | string |
Conteúdo da nota em texto simples. |
|
Corpo HTML
|
note.body_html | string |
Conteúdo da nota em formato HTML. Ou corpo ou body_html tem de ser aprovado. |
|
attachments
|
note.attachments | array of string |
AddNote_ResponseV2
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em Date-Time
|
conversation.created_at | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Id
|
conversation.id | integer |
ID único da nota. |
|
Privado
|
conversation.private | boolean |
Defina como true se a nota for privada. |
|
Atualizado em Date-Time
|
conversation.updated_at | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
ID de Utilizador
|
conversation.user_id | integer |
User_id do agente que está adicionando a nota. |
|
Body
|
conversation.body_text | string |
Conteúdo da nota em texto simples. |
|
Corpo HTML
|
conversation.body | string |
Conteúdo da nota em formato HTML. Ou corpo ou body_html tem de ser aprovado. |
|
attachments
|
conversation.attachments | array of string | |
|
ID do bilhete
|
conversation.ticket_id | integer |
Identificação única do bilhete. |