Freshworks Freshservice

Versão da integração: 14.0

Exemplos de utilização

Integração com o serviço de assistência técnica.

Configuração do Freshservice

A integração do Freshservice com o Google Security Operations funciona com base nas chaves da API do Freshservice.

Como obter a chave da API da conta no Freshservice

  1. Inicie sessão no portal de apoio técnico do Freshservice
  2. Clique na imagem do perfil da conta no canto superior direito do portal
  3. Aceda à página de definições do perfil
  4. A chave da API da conta está disponível abaixo da secção de alteração da palavra-passe à sua direita
  5. Guarde esta chave de API. Vai precisar dela para a configuração da integração do Google SecOps.

Configure a integração do Freshworks Freshservice no Google SecOps

Para obter instruções detalhadas sobre como configurar uma integração no Google SecOps, consulte o artigo Configure integrações.

Parâmetros de integração

Use os seguintes parâmetros para configurar a integração:

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Raiz da API String https://yourdomain.freshservice.com Sim URL raiz da API da instância do Freshservice.
Chave de API Palavra-passe N/A Sim Chave da API Freshservice a usar na integração.
Validar SSL Caixa de verificação Marcado Não Se estiver ativada, a integração verifica se o URL raiz está configurado com um certificado válido.

Ações

Tchim-tchim

Descrição

Teste a conetividade à instância do Freshservice com os parâmetros fornecidos na página de configuração da integração no separador Google Security Operations Marketplace.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se tiver êxito: "Ligação à instância do Freshservice estabelecida com êxito com os parâmetros de ligação fornecidos!"

A ação deve falhar e parar a execução de um playbook:se ocorrer um erro crítico, como credenciais incorretas ou perda de conetividade: "Falha ao estabelecer ligação à instância do Freshservice! O erro é {0}".format(exception.stacktrace)

 Geral

Crie listas de pedidos

Descrição

Apresentar uma lista de pedidos do Freshservice com base nos critérios de pesquisa especificados. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Tipo de bilhete LDD Tudo Não Especifique o tipo de pedido a devolver.
Requerente String N/A Não Especifique o email do requerente dos pedidos a devolver.
Inclua estatísticas Caixa de verificação Desmarcado Não Se estiver ativada, a ação devolve estatísticas adicionais sobre os pedidos.
Pesquise as últimas X horas Número inteiro N/A Não Especifique o período para pesquisar bilhetes.
Linhas por página Número inteiro 30 Não Especifique quantos pedidos devem ser devolvidos por página para a paginação do Freshservice.
Página inicial Número inteiro 1 Não Especifique a partir de que página devem ser devolvidos os pedidos com a paginação do Freshservice.
Máximo de linhas a devolver Número inteiro 30 Não Especifique quantos registos de pedidos de apoio técnico a ação deve devolver no total.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "tickets": [
        {
            "subject": "Support Needed...",
            "group_id": null,
            "department_id": null,
            "category": null,
            "sub_category": null,
            "item_category": null,
            "requester_id": 17000032840,
            "responder_id": null,
            "due_by": "2021-07-08T21:00:00Z",
            "fr_escalated": false,
            "deleted": false,
            "spam": false,
            "email_config_id": null,
            "fwd_emails": [],
            "reply_cc_emails": [],
            "cc_emails": [],
            "is_escalated": false,
            "fr_due_by": "2021-07-01T18:00:00Z",
            "id": 7,
            "priority": 1,
            "status": 2,
            "source": 2,
            "created_at": "2021-06-29T08:56:24Z",
            "updated_at": "2021-06-29T10:04:51Z",
            "to_emails": null,
            "type": "Incident",
            "description": "<div>Details about the issue...</div>",
            "description_text": "Details about the issue...",
            "custom_fields": {},
            "requester": {
                "email": "dana@example.com",
                "id": 17000032840,
                "mobile": "dana@example.com",
                "name": "Dana",
                "phone": null
            }
        }
    ]
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se forem encontrados pedidos (is_success = true): "Successfully fetched Freshservice tickets." (Pedidos do Freshservice obtidos com êxito.)
  • Se não forem devolvidos pedidos (is_success = false): "Não foram encontrados pedidos para os parâmetros de entrada fornecidos."
  • Se recebeu um erro da API ao obter pedidos (is_success = false): "Falha ao listar pedidos com os parâmetros de entrada fornecidos. O erro é: {error from the API}"

A ação deve falhar e parar a execução de um guia interativo:

Se ocorrer um erro crítico, como credenciais incorretas, sem ligação ao servidor, entre outros: "Erro ao executar a ação "Listar bilhetes". Motivo: {0}''.format(error.Stacktrace)

 Geral
Tabela

Nome da tabela: Freshservice Tickets Found

Colunas da tabela:

ID

Tipo

Assunto

Descrição

Email do requerente

Categoria

Estado

Prioridade

Origem

Data de criação

Data de atualização

Data de vencimento

Encaminhado

Eliminado

 Geral

Criar pedido

Descrição

Criar um pedido do Freshservice.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Assunto String N/A Sim Especifique o campo de assunto para o pedido criado.
Descrição String N/A Sim Especifique o campo de descrição para o pedido criado.
Email do requerente String N/A Sim Especifique o email do requerente para o pedido criado.
Agente atribuído a String N/A Não Especifique o email do agente ao qual quer atribuir o pedido.
Atribuição de grupo a String N/A Não Especifique o nome do grupo ao qual quer atribuir o pedido.
Prioridade LDD Médio Sim Especifique a prioridade a atribuir ao pedido.
Urgência LDD Médio Não Especifique a urgência a atribuir ao pedido de apoio técnico.
Impacto LDD Médio Não Especifique o impacto a atribuir ao pedido.
Etiquetas String N/A Não Especifique as etiquetas a atribuir ao pedido. O parâmetro aceita vários valores como uma string separada por vírgulas.
Nome do departamento String N/A Não Especifique o nome do departamento que vai ser proprietário ou gerir o pedido.
Campos personalizados JSON N/A Não

Especifique um objeto JSON que contenha campos personalizados a adicionar ao pedido. A app Action anexa novos campos personalizados a todos os existentes para um pedido. Exemplo de formato:

{"key1":"value1", "key2":"value2"}
Anexos de ficheiros a adicionar String (CSV) N/A Não Especifique o caminho completo do ficheiro a carregar com o pedido. O parâmetro aceita vários valores como uma string separada por vírgulas. O tamanho total dos anexos não pode exceder 15 MB.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "ticket": {
        "cc_emails": [],
        "fwd_emails": [],
        "reply_cc_emails": [],
        "fr_escalated": false,
        "spam": false,
        "email_config_id": null,
        "group_id": null,
        "priority": 2,
        "requester_id": 17000032840,
        "responder_id": null,
        "source": 2,
        "status": 2,
        "subject": "Support Needed 4...",
        "to_emails": null,
        "department_id": null,
        "id": 10,
        "type": "Incident",
        "due_by": "2021-07-02T18:00:00Z",
        "fr_due_by": "2021-06-30T20:00:00Z",
        "is_escalated": false,
        "description": "<div>Details about the issue...</div>",
        "description_text": "Details about the issue...",
        "category": null,
        "sub_category": null,
        "item_category": null,
        "custom_fields": {
            "test": "very_test"
        },
        "created_at": "2021-06-30T08:01:30Z",
        "updated_at": "2021-06-30T08:01:30Z",
        "tags": [
            "test"
        ],
        "attachments": []
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito (is_success=true): foi criado um novo pedido do Freshservice.

  • Se a ação não tiver sido executada devido aos parâmetros fornecidos(is_success =false): falha ao criar um novo pedido com os parâmetros fornecidos. O erro é: <error text>.

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal, um erro do SDK, como credenciais incorretas, sem ligação ao servidor, ou outro: "Erro ao executar a ação "Criar pedido". Motivo: {0}''.format(error.Stacktrace)

 Geral

Atualizar bilhete

Descrição

Atualizar um pedido do Freshservice com base nos parâmetros de entrada da ação fornecidos. Tenha em atenção que, se forem fornecidas novas etiquetas para o pedido, devido às limitações da API Freshservice, a ação substitui as etiquetas existentes no pedido e não acrescenta novas às existentes.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido Número inteiro N/A Sim Especifique o ID do pedido para atualizar.
Estado LDD Não alterado Não Especifique o novo estado do pedido.
Assunto String N/A Não Especifique o campo do assunto a atualizar.
Descrição String N/A Não Especifique o campo de descrição a atualizar.
Email do requerente String N/A Não Especifique o email do requerente a atualizar.
Agente atribuído a String N/A Não Especifique o email do agente que quer atualizar.
Atribuição de grupo a String N/A Não Especifique o nome do grupo que quer atualizar.
Prioridade LDD Não alterado Não Especifique a prioridade para atualizar.
Urgência LDD Não alterado Não Especifique a urgência para atualizar.
Impacto LDD Não alterado Não Especifique o impacto a atualizar.
Etiquetas String N/A Não Especifique as etiquetas a substituir no pedido. O parâmetro aceita vários valores como uma string separada por vírgulas. Tenha em atenção que, devido às limitações da API Freshservice, a ação substitui as etiquetas existentes no pedido, em vez de acrescentar novas às existentes.
Campos personalizados JSON N/A Não

Especifique um objeto JSON que contenha campos personalizados a adicionar ao pedido. A app Action anexa novos campos personalizados a todos os existentes para um pedido. Exemplo de formato:

{"key1":"value1", "key2":"value2"}
Anexos de ficheiros a adicionar String (CSV) N/A Não Especifique o caminho completo do ficheiro a carregar com o pedido. O parâmetro aceita vários valores como uma string separada por vírgulas. O tamanho total dos anexos não pode exceder 15 MB.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "ticket": {
        "cc_emails": [],
        "fwd_emails": [],
        "reply_cc_emails": [],
        "spam": false,
        "email_config_id": null,
        "fr_escalated": false,
        "group_id": 17000034192,
        "priority": 1,
        "requester_id": 17002188556,
        "responder_id": 17002188556,
        "source": 2,
        "status": 2,
        "subject": "Support Needed 9...",
        "description": "Details about the issue...",
        "description_text": "Details about the issue...",
        "category": null,
        "sub_category": null,
        "item_category": null,
        "custom_fields": {
            "test": "very_test"
        },
        "id": 12,
        "type": "Incident",
        "to_emails": null,
        "department_id": 17000016543,
        "is_escalated": false,
        "tags": [
            "test"
        ],
        "due_by": "2021-07-09T17:00:00-04:00",
        "fr_due_by": "2021-07-02T14:00:00-04:00",
        "created_at": "2021-06-30T08:36:43Z",
        "updated_at": "2021-06-30T09:39:12Z",
        "attachments": []
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • O pedido do Freshservice <ticket id> foi atualizado.

  • Se a ação não tiver sido executada devido aos parâmetros fornecidos(is_success =false)

    • Não foi possível atualizar o pedido <ticket_id> com os parâmetros fornecidos. O erro é: <error text>.

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal, um erro do SDK, como credenciais incorretas, sem ligação ao servidor, ou outro: "Erro ao executar a ação "Atualizar pedido". Motivo: {0}''.format(error.Stacktrace)

 Geral

Listar conversas de pedidos

Descrição

Apresenta uma lista de conversas de pedidos do Freshservice com base nos critérios de pesquisa especificados. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido Número inteiro N/A Sim Especifique o ID do pedido para o qual quer devolver conversas.
Linhas por página Número inteiro 30 Não Especifique quantas conversas de pedidos devem ser devolvidas por página para a paginação do Freshservice.
Página inicial Número inteiro 1 Não Especifique a partir de que página devem ser devolvidas as conversas de pedidos com a paginação do Freshservice.
Máximo de linhas a devolver Número inteiro 30 Não Especifique quantas ações de conversas de pedidos de apoio técnico devem ser devolvidas no total.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "conversations": [
        {
            "id": 17014994010,
            "user_id": 17000032840,
            "to_emails": [],
            "body": "<div>This is a test note!</div>",
            "body_text": "This is a test note!",
            "ticket_id": 12,
            "created_at": "2021-07-05T06:58:32Z",
            "updated_at": "2021-07-05T06:58:32Z",
            "incoming": false,
            "private": false,
            "support_email": null,
            "source": 2,
            "from_email": null,
            "cc_emails": [],
            "bcc_emails": null,
            "attachments": []
        },
        {
            "id": 17014993985,
            "user_id": 17000032840,
            "to_emails": [
                "dana@example.com"
            ],
            "body": "<div>We are working on this issue. Will keep you posted.</div>",
            "body_text": "We are working on this issue. Will keep you posted.",
            "ticket_id": 12,
            "created_at": "2021-07-05T06:57:27Z",
            "updated_at": "2021-07-05T06:57:27Z",
            "incoming": false,
            "private": false,
            "support_email": "helpdesk@siemplifyservicedesk.freshservice.com",
            "source": 0,
            "from_email": "helpdesk@siemplifyservicedesk.freshservice.com",
            "cc_emails": [],
            "bcc_emails": [],
            "attachments": []
        }
    ],
    "meta": {
        "count": 2
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se forem encontradas conversas de pedidos (is_success = true):
    "Conversas do pedido do Freshservice <ticket id> obtidas com êxito."
  • Se não forem devolvidas conversas de pedidos (is_success = false):
    "Não foram encontradas conversas de pedidos para o pedido <ticket id>"
  • Se o ID do pedido indicado não foi encontrado (is_success = false):
    "Não foi encontrado o pedido <ID do pedido> no Freshservice.
  • Se recebeu um erro da API ao obter pedidos (is_success = false): "Failed to list ticket conversations with the provided input parameters. O erro é: {error from the API}"

A ação deve falhar e parar a execução de um guia interativo:

Se ocorrer um erro fatal, como credenciais incorretas, sem ligação ao servidor, entre outros:

"Erro ao executar a ação "List Ticket Conversations". Motivo: {0}''.format(error.Stacktrace)

 Geral
Tabela

Nome da tabela: Freshservice Ticket <ticket id> Conversations

Colunas da tabela:

ID

Tipo

Visibilidade

Email do utilizador

Texto

Email de origem

Email de destino

Cc de email

Email em BCC

 Geral

Adicione uma resposta ao pedido

Descrição

Adicionar uma resposta a um pedido do Freshservice. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido Número inteiro N/A Sim Especifique o ID do pedido para o qual quer devolver conversas.
Texto da resposta String N/A Sim Especifique o texto de resposta a adicionar ao pedido.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
    "conversation": {
        "id": 17014998560,
        "user_id": 17000032840,
        "from_email": "helpdesk@siemplifyservicedesk.freshservice.com",
        "cc_emails": [],
        "bcc_emails": [],
        "body": "<div>We are working on this issue. Will keep you posted.2</div>",
        "body_text": "We are working on this issue. Will keep you posted.2",
        "ticket_id": 12,
        "to_emails": [
            "dana@example.com"
        ],
        "attachments": [],
        "created_at": "2021-07-05T09:19:02Z",
        "updated_at": "2021-07-05T09:19:02Z"
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • Nova resposta adicionada ao pedido <ticket id>.

  • Se o ID do pedido fornecido não foi encontrado (is_success = false):

    • "Não foi encontrado o pedido <ticket id> no Freshservice.

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal ou um erro do SDK, como credenciais incorretas, sem ligação ao servidor ou outro: "Erro ao executar a ação "Adicionar uma resposta ao pedido". Motivo: {0}''.format(error.Stacktrace)

 Geral

Adicione uma nota ao registo

Descrição

Adicione uma nota a um pedido do Freshservice. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido Número inteiro N/A Sim Especifique o ID do pedido para o qual quer devolver conversas.
Tipo de nota LDD Privado Não Especifique o tipo de ação de nota que deve adicionar ao pedido.
Texto da nota String N/A Sim Especifique o texto da nota a adicionar ao pedido.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "conversation": {
        "id": 17014999107,
        "incoming": false,
        "private": false,
        "user_id": 17000032840,
        "support_email": null,
        "body": "<div>This is a test note2!</div>",
        "body_text": "This is a test note2!",
        "ticket_id": 12,
        "to_emails": [],
        "attachments": [],
        "created_at": "2021-07-05T09:35:28Z",
        "updated_at": "2021-07-05T09:35:28Z"
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • A nova nota de <note type> é adicionada ao pedido <ticket id>.

  • Se o ID do pedido fornecido não foi encontrado (is_success = false):

    • "Não foi encontrado o pedido <ticket id> no Freshservice.

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal, um erro do SDK, como credenciais incorretas, sem ligação ao servidor, ou outro: "Erro ao executar a ação "Adicionar uma nota ao pedido". Motivo: {0}''.format(error.Stacktrace)

 Geral

Listar agentes

Descrição

Apresentar uma lista de agentes do Freshservice com base nos critérios de pesquisa especificados. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Email do agente String N/A Não Especifique o endereço de email para o qual devolver os registos de agentes.
Estado do agente LDD TUDO Não Especifique os estados do agente a devolver.
Incluir agentes não ativos Caixa de verificação Desmarcado Não Se estiver ativada, os resultados incluem registos de agentes não ativos.
Linhas por página Número inteiro 30 Não Especifique quantos registos de agentes devem ser devolvidos por página para a paginação do Freshservice.
Página inicial Número inteiro 1 Não Especifique a partir de que página devem ser devolvidos os registos de agentes com a paginação do Freshservice.
Máximo de linhas a devolver Número inteiro 30 Não Especifique quantos registos de agentes a ação deve devolver no total.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "agents": [
        {
            "active": true,
            "address": null,
            "background_information": null,
            "can_see_all_tickets_from_associated_departments": false,
            "created_at": "2021-06-29T10:37:36Z",
            "custom_fields": {},
            "department_ids": [
                17000016543
            ],
            "email": "dana@example.com",
            "external_id": null,
            "first_name": "dmitry",
            "has_logged_in": false,
            "id": 17002188556,
            "job_title": null,
            "language": "en",
            "last_active_at": null,
            "last_login_at": null,
            "last_name": "s",
            "location_id": null,
            "mobile_phone_number": null,
            "occasional": true,
            "reporting_manager_id": null,
            "role_ids": [
                17000023339
            ],
            "roles": [
                {
                    "role_id": 17000023339,
                    "assignment_scope": "entire_helpdesk",
                    "groups": []
                }
            ],
            "scopes": {
                "ticket": null,
                "problem": null,
                "change": null,
                "asset": null,
                "solution": null,
                "contract": null
            },
            "scoreboard_level_id": 1,
            "signature": "<p> </p>\n",
            "time_format": "12h",
            "time_zone": "American Samoa",
            "updated_at": "2021-06-29T10:37:36Z",
            "work_phone_number": null,
            "group_ids": [
                17000034192
            ],
            "member_of": [
                17000034192
            ],
            "observer_of": []
        },
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se forem encontrados agentes (is_success = true): "Successfully fetched Freshservice agents." (Agentes do Freshservice obtidos com êxito.)
  • Se não forem devolvidos agentes (is_success = false): "Não foram encontrados agentes para os parâmetros de entrada fornecidos."
  • Se recebeu um erro da API ao obter agentes (is_success = false): "Falha ao apresentar agentes com os parâmetros de entrada fornecidos. O erro é: {error from the API}"

A ação deve falhar e parar a execução de um guia interativo:

Se ocorrer um erro fatal, como credenciais incorretas, sem ligação ao servidor, entre outros:

"Erro ao executar a ação "List Agents". Motivo: {0}''.format(error.Stacktrace)

 Geral

Tabela

Nome da tabela: Freshservice Agents Found

Colunas da tabela:

ID

Email

Nome próprio

Apelido

Funções

Grupos

Departamentos

Localização

Ativo

Ocasional

Campos personalizados

Data de criação

Data de atualização

Data da última atividade

Data do último início de sessão

 Geral

Listar requerentes

Descrição

Listar os requerentes registados no Freshservice com base nos critérios de pesquisa especificados. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Email do requerente String N/A Não Especifique o endereço de email para o qual devolver os registos do requerente.
Linhas por página Número inteiro 30 Não Especifique quantos registos de agentes devem ser devolvidos por página para a paginação do Freshservice.
Página inicial Número inteiro 1 Não Especifique a partir de que página devem ser devolvidos os registos de agentes com a paginação do Freshservice.
Máximo de linhas a devolver Número inteiro 30 Não Especifique quantos registos de agentes a ação deve devolver no total.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "requesters": [
        {
            "active": true,
            "address": null,
            "background_information": null,
            "can_see_all_tickets_from_associated_departments": false,
            "created_at": "2020-07-06T08:07:30Z",
            "custom_fields": {
                "test": null
            },
            "department_ids": [],
            "external_id": null,
            "first_name": "Dana",
            "has_logged_in": false,
            "id": 17000038164,
            "job_title": null,
            "language": "en",
            "last_name": "Doe",
            "location_id": null,
            "mobile_phone_number": null,
            "primary_email": "dana@example.com",
            "reporting_manager_id": null,
            "secondary_emails": [],
            "time_format": "12h",
            "time_zone": "Eastern Time (US & Canada)",
            "updated_at": "2020-07-06T08:07:30Z",
            "work_phone_number": null
        }
    ]
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se forem encontrados requerentes (is_success = true):
    "Successfully fetched Freshservice registered requesters." (Foram obtidos com êxito os requerentes registados do Freshservice.)
  • Se não forem devolvidos requerentes (is_success = false):
    "Não foram encontrados requerentes para os parâmetros de entrada fornecidos."
  • Se recebeu um erro da API ao obter os requerentes (is_success = false): "Falha ao listar os requerentes com os parâmetros de entrada fornecidos. O erro é: {error from the API}"

A ação deve falhar e parar a execução de um guia interativo:

Se ocorrer um erro fatal, como credenciais incorretas, sem ligação ao servidor, entre outros:

"Erro ao executar a ação "List Requesters". Motivo: {0}''.format(error.Stacktrace)

 Geral

Tabela

Nome da tabela: Freshservice Requester Found

Colunas da tabela:

ID

Email

Nome próprio

Apelido

Departamentos

Localização

Ativo

Campos personalizados

Data de criação

Data de atualização

 Geral

Criar agente

Descrição

Crie um novo agente do Freshservice. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Email String N/A Sim Especifique o email do agente a criar.
Nome próprio String N/A Sim Especifique o primeiro nome do agente a criar.
Apelido String N/A Não Especifique o apelido do agente a criar.
É ocasional Caixa de verificação Desmarcado Não Se estiver ativada, o agente é criado como agente ocasional. Caso contrário, é criado como agente a tempo inteiro.
Pode ver todos os pedidos dos departamentos associados Caixa de verificação Desmarcado Não

Se estiver ativada, o agente pode ver todos os pedidos dos departamentos associados.
Departamentos CSV N/A Não Especifique os nomes dos departamentos associados ao agente. O parâmetro aceita vários valores como uma string separada por vírgulas.
Localização String N/A Não Especifique o nome da localização associado ao agente.
Inscrições em grupos CSV N/A Não Especifique os nomes dos grupos dos quais o agente deve ser membro.
Funções CSV N/A Sim

Especifique as funções a adicionar ao agente. O parâmetro aceita vários valores como uma string separada por vírgulas.

Exemplo: {"role_id":17000023338,"assignment_scope": ""}
Cargo String N/A Não Especifique o cargo do agente.
Campos personalizados JSON N/A Não

Especifique um objeto JSON que contenha campos personalizados a adicionar ao agente. A app Action anexa novos campos personalizados a todos os existentes para um pedido. Exemplo de formato:

{"key1":"value1", "key2":"value2"}

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "agent": {
        "active": true,
        "address": null,
        "background_information": null,
        "can_see_all_tickets_from_associated_departments": false,
        "created_at": "2021-07-06T05:40:41Z",
        "custom_fields": {
            "test": "testvalue"
        },
        "department_ids": [],
        "email": "rolanda.hooch@hogwarts.edu",
        "external_id": null,
        "first_name": "Rolanda",
        "has_logged_in": false,
        "id": 17002198254,
        "job_title": "Flying Instructor",
        "language": "en",
        "last_active_at": null,
        "last_login_at": null,
        "last_name": "Hooch",
        "location_id": null,
        "mobile_phone_number": "553632",
        "occasional": true,
        "reporting_manager_id": null,
        "role_ids": [
            17000023338
        ],
        "roles": [
            {
                "role_id": 17000023338,
                "assignment_scope": "entire_helpdesk",
                "groups": []
            }
        ],
        "scopes": {
            "ticket": null,
            "problem": null,
            "change": null,
            "asset": null,
            "solution": null,
            "contract": null
        },
        "scoreboard_level_id": 1,
        "signature": null,
        "time_format": "12h",
        "time_zone": "Eastern Time (US & Canada)",
        "updated_at": "2021-07-06T05:40:41Z",
        "work_phone_number": "443532",
        "group_ids": [
            17000034192
        ],
        "member_of": [
            17000034192
        ],
        "observer_of": []
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • Foi criado um novo agente do Freshservice.

  • Se a ação não tiver sido executada devido aos parâmetros fornecidos(is_success =false)

    • Não foi possível criar um novo agente com os parâmetros fornecidos. O erro é: <error text>.

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal ou um erro do SDK, como credenciais incorretas, sem ligação ao servidor ou outro: "Erro ao executar a ação "Criar agente". Motivo: {0}''.format(error.Stacktrace)

 Geral

Atualize o agente

Descrição

Atualize o agente do Freshservice existente. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do agente Número inteiro N/A Sim Especifique o ID do agente a atualizar.
Email String N/A Não Especifique o email do agente a atualizar.
Nome próprio String N/A Não Especifique o nome próprio do agente a atualizar.
Apelido String N/A Não Especifique o apelido do agente a atualizar.
É ocasional Caixa de verificação Desmarcado Não Se estiver ativado, o agente é atualizado como agente ocasional. Caso contrário, é um agente a tempo inteiro.
Pode ver todos os pedidos dos departamentos associados Caixa de verificação Desmarcado Não

Se estiver ativada, o agente pode ver todos os pedidos dos departamentos associados.
Departamentos CSV N/A Não Especifique os nomes dos departamentos associados ao agente. O parâmetro aceita vários valores como uma string separada por vírgulas.
Localização String N/A Não Especifique o nome da localização associado ao agente.
Inscrições em grupos CSV N/A Não Especifique os nomes dos grupos dos quais o agente deve ser membro.
Funções CSV N/A Não

Especifique as funções a adicionar ao agente. O parâmetro aceita vários valores como uma string separada por vírgulas.

Exemplo: {"role_id":17000023338,"assignment_scope": "entire_helpdesk"}
Cargo String N/A Não Especifique o cargo do agente.
Campos personalizados JSON N/A Não

Especifique um objeto JSON que contenha campos personalizados a adicionar ao agente. A app Action anexa novos campos personalizados a todos os existentes para um pedido. Exemplo de formato:

{"key1":"value1", "key2":"value2"}

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "agent": {
        "active": true,
        "address": null,
        "background_information": null,
        "can_see_all_tickets_from_associated_departments": false,
        "created_at": "2021-07-06T05:40:41Z",
        "custom_fields": {
            "test": "testvalue"
        },
        "department_ids": [],
        "email": "rolanda.hooch@hogwarts.edu",
        "external_id": null,
        "first_name": "Rolanda",
        "has_logged_in": false,
        "id": 17002198254,
        "job_title": "Flying Instructor",
        "language": "en",
        "last_active_at": null,
        "last_login_at": null,
        "last_name": "Hooch",
        "location_id": null,
        "mobile_phone_number": "553632",
        "occasional": true,
        "reporting_manager_id": null,
        "role_ids": [
            17000023338
        ],
        "roles": [
            {
                "role_id": 17000023338,
                "assignment_scope": "entire_helpdesk",
                "groups": []
            }
        ],
        "scopes": {
            "ticket": null,
            "problem": null,
            "change": null,
            "asset": null,
            "solution": null,
            "contract": null
        },
        "scoreboard_level_id": 1,
        "signature": null,
        "time_format": "12h",
        "time_zone": "Eastern Time (US & Canada)",
        "updated_at": "2021-07-06T05:40:41Z",
        "work_phone_number": "443532",
        "group_ids": [
            17000034192
        ],
        "member_of": [
            17000034192
        ],
        "observer_of": []
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • O agente do Freshservice <agent_id> foi atualizado.

  • Se a ação não tiver sido executada devido aos parâmetros fornecidos(is_success =false)

    • Não foi possível atualizar o agente do Freshservice <agent_id> com os parâmetros fornecidos. O erro é: <error text>.

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal, um erro do SDK, como credenciais incorretas, sem ligação ao servidor ou outro: "Erro ao executar a ação "Atualizar agente". Motivo: {0}''.format(error.Stacktrace)

 Geral

Desative o agente

Descrição

Desative o agente do Freshservice. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do agente Número inteiro N/A Sim Especifique o ID do agente a desativar.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "agent": {
        "active": false,
        "address": null,
        "background_information": null,
        "can_see_all_tickets_from_associated_departments": false,
        "created_at": "2021-07-06T05:40:41Z",
        "custom_fields": {
            "test": "testvalue3"
        },
        "department_ids": [],
        "email": "rolanda.hooch@hogwarts.edu",
        "external_id": null,
        "first_name": "Rolanda",
        "has_logged_in": false,
        "id": 17002198254,
        "job_title": "Flying Instructor",
        "language": "en",
        "last_active_at": null,
        "last_login_at": null,
        "last_name": "Hooch",
        "location_id": null,
        "mobile_phone_number": "553632",
        "occasional": true,
        "reporting_manager_id": null,
        "role_ids": [
            17000023338
        ],
        "roles": [
            {
                "role_id": 17000023338,
                "assignment_scope": "entire_helpdesk",
                "groups": []
            }
        ],
        "scopes": {
            "ticket": null,
            "problem": null,
            "change": null,
            "asset": null,
            "solution": null,
            "contract": null
        },
        "scoreboard_level_id": 2,
        "signature": "<p> </p>\n",
        "time_format": "24h",
        "time_zone": "Eastern Time (US & Canada)",
        "updated_at": "2021-07-06T06:26:59Z",
        "work_phone_number": "443532",
        "group_ids": [],
        "member_of": [],
        "observer_of": []
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • O agente do Freshservice <agent_id> está desativado.

  • Se a ação não tiver sido executada devido ao erro 404 (is_success =false)

    • Não foi possível encontrar o agente do Freshservice <agent_id> para desativar.

  • Se a ação não tiver sido executada devido ao erro 403 (is_success =false)

    • Não foi possível desativar o agente do Freshservice <agent_id>. Já pode ter sido desativado. Resposta da API: "code": "access_denied","message": "Não tem autorização para realizar esta ação."

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal ou um erro do SDK, como credenciais incorretas, sem ligação ao servidor ou outro: "Erro ao executar a ação "Desativar agente". Motivo: {0}''.format(error.Stacktrace)

 Geral

Criar requerente

Descrição

Crie um novo requerente do Freshservice. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Email String N/A Sim Especifique o email do requerente a criar.
Nome próprio String N/A Sim Especifique o nome próprio do requerente a criar.
Apelido String N/A Não Especifique o apelido do requerente a criar.
Pode ver todos os pedidos dos departamentos associados Caixa de verificação Desmarcado Não

Se estiver ativada, o requerente pode ver todos os pedidos dos departamentos associados.
Departamentos CSV N/A Não Especifique os nomes dos departamentos associados ao requerente . O parâmetro aceita vários valores como uma string separada por vírgulas.
Localização String N/A Não Especifique o nome da localização associado ao requerente .
Cargo String N/A Não Especifique o cargo do requerente.
Campos personalizados JSON N/A Não

Especifique um objeto JSON que contenha campos personalizados a adicionar ao requerente. A app Action anexa novos campos personalizados a todos os existentes para um pedido. Exemplo de formato:

{"key1":"value1", "key2":"value2"}

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "requester": {
        "active": true,
        "address": null,
        "background_information": null,
        "can_see_all_tickets_from_associated_departments": false,
        "created_at": "2021-07-06T08:12:47Z",
        "custom_fields": {
            "test": "testvalue"
        },
        "department_ids": [],
        "external_id": null,
        "first_name": "Rolanda",
        "has_logged_in": false,
        "id": 17002198308,
        "job_title": "Flying Instructor",
        "language": "en",
        "last_name": "Hooch",
        "location_id": null,
        "mobile_phone_number": null,
        "primary_email": "rolanda.hooch2@hogwarts.edu",
        "reporting_manager_id": null,
        "secondary_emails": [],
        "time_format": "12h",
        "time_zone": "Eastern Time (US & Canada)",
        "updated_at": "2021-07-06T08:12:47Z",
        "work_phone_number": null
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • Foi criado um novo requerente do Freshservice.

  • Se a ação não tiver sido executada devido aos parâmetros fornecidos(is_success =false)

    • Não foi possível criar um novo requerente com os parâmetros fornecidos. O erro é: <error text>.

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal ou um erro do SDK, como credenciais incorretas, sem ligação ao servidor ou outro: "Erro ao executar a ação "Criar requerente". Motivo: {0}''.format(error.Stacktrace)

 Geral

Atualizar requerente

Descrição

Atualize o requerente do Freshservice existente. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do requerente Número inteiro N/A Sim Especifique o ID do requerente para atualizar.
Email String N/A Não Especifique o email do requerente a atualizar.
Nome próprio String N/A Não Especifique o nome próprio do requerente a atualizar.
Apelido String N/A Não Especifique o apelido do requerente a atualizar.
Pode ver todos os pedidos dos departamentos associados Caixa de verificação Desmarcado Não

Se estiver ativada, o requerente pode ver todos os pedidos dos departamentos associados.
Departamentos CSV N/A Não Especifique os nomes dos departamentos associados ao requerente. O parâmetro aceita vários valores como uma string separada por vírgulas.
Localização String N/A Não Especifique o nome da localização associado ao requerente.
Cargo String N/A Não Especifique o cargo do requerente.
Campos personalizados JSON N/A Não

Especifique um objeto JSON que contenha campos personalizados a adicionar ao requerente. A app Action anexa novos campos personalizados a todos os existentes para um pedido. Exemplo de formato:

{"key1":"value1", "key2":"value2"}

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "agent": {
        "active": true,
        "address": null,
        "background_information": null,
        "can_see_all_tickets_from_associated_departments": false,
        "created_at": "2021-07-06T05:40:41Z",
        "custom_fields": {
            "test": "testvalue"
        },
        "department_ids": [],
        "email": "rolanda.hooch@hogwarts.edu",
        "external_id": null,
        "first_name": "Rolanda",
        "has_logged_in": false,
        "id": 17002198254,
        "job_title": "Flying Instructor",
        "language": "en",
        "last_active_at": null,
        "last_login_at": null,
        "last_name": "Hooch",
        "location_id": null,
        "mobile_phone_number": "553632",
        "occasional": true,
        "reporting_manager_id": null,
        "role_ids": [
            17000023338
        ],
        "roles": [
            {
                "role_id": 17000023338,
                "assignment_scope": "entire_helpdesk",
                "groups": []
            }
        ],
        "scopes": {
            "ticket": null,
            "problem": null,
            "change": null,
            "asset": null,
            "solution": null,
            "contract": null
        },
        "scoreboard_level_id": 1,
        "signature": null,
        "time_format": "12h",
        "time_zone": "Eastern Time (US & Canada)",
        "updated_at": "2021-07-06T05:40:41Z",
        "work_phone_number": "443532",
        "group_ids": [
            17000034192
        ],
        "member_of": [
            17000034192
        ],
        "observer_of": []
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • O requerente do Freshservice <requester_id> foi atualizado.

  • Se a ação não tiver sido executada devido aos parâmetros fornecidos(is_success =false)

    • Não foi possível atualizar o requerente do Freshservice <requester_id> com os parâmetros fornecidos. O erro é: <error text>.

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal, um erro do SDK, como credenciais incorretas, sem ligação ao servidor, ou outro: "Erro ao executar a ação "Atualizar requerente". Motivo: {0}''.format(error.Stacktrace)

 Geral

Desative o requerente

Descrição

Desative o requerente do Freshservice. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do requerente Número inteiro N/A Sim Especifique o ID do requerente a desativar.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • O requerente do Freshservice <requester_id> está desativado.

  • Se a ação não tiver sido executada devido ao erro 404 (is_success =false)

    • Não foi possível encontrar o requerente do Freshservice <requester_id> para desativar.

  • Se a ação não tiver sido executada devido ao erro 405 (is_success =false)

    • Não foi possível desativar o requerente do Freshservice <requester_id>. Talvez já tenha sido desativado. Resposta da API: "message": "O método DELETE não é permitido. Deve ser um dos seguintes métodos: GET"

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal, um erro do SDK, como credenciais incorretas, sem ligação ao servidor, ou outro: "Erro ao executar a ação "Desativar requerente". Motivo: {0}''.format(error.Stacktrace)

 Geral

Listar entradas de tempo de pedidos

Descrição

Apresenta uma lista de entradas de tempo de pedidos do Freshservice com base nos critérios de pesquisa especificados. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido Número inteiro N/A Sim Especifique o ID do pedido para devolver as entradas de tempo.
Email do agente String N/A Sim Especifique o email do agente para listar as entradas de tempo do pedido.
Linhas por página Número inteiro 30 Não Especifique quantas entradas de tempo de registo devem ser devolvidas por página para a paginação do Freshservice.
Página inicial Número inteiro 1 Não Especifique a partir de que página devem ser devolvidas as entradas de tempo dos pedidos com a paginação do Freshservice.
Máximo de linhas a devolver Número inteiro 30 Não Especifique quantas entradas de tempo de registo de incidentes a ação deve devolver no total.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
   "time_entries": [
       {
           "id": 17000399635,
           "created_at": "2021-07-08T06:26:47Z",
           "updated_at": "2021-07-08T06:26:47Z",
           "start_time": "2021-07-08T06:26:47Z",
           "timer_running": false,
           "billable": true,
           "time_spent": "01:00",
           "executed_at": "2021-07-08T06:26:47Z",
           "task_id": null,
           "note": "test_entry2",
           "agent_id": 17002188556,
           "custom_fields": {}
       }
   ]
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • If found ticket time entries (is_success = true):
    "Successfully fetched Freshservice ticket <ticket id> time entries."
  • Se não forem devolvidas entradas de tempo de registo (is_success = false):
    "Não foram encontradas entradas de tempo de registo para o registo <ticket id>"
  • Se o ID do pedido indicado não foi encontrado (is_success = false):
    "Não foi encontrado o pedido <ID do pedido> no Freshservice.
  • Se não foi encontrado nenhum ID do agente para o email do agente fornecido (is_success = false):
    "Não foi encontrado o agente <agent_email> no Freshservice.
  • Se recebeu um erro da API ao obter entradas de tempo de registo de pedidos (is_success = false): "Failed to list ticket time entries with the provided input parameters. O erro é: {error from the API}"

A ação deve falhar e parar a execução de um guia interativo:

Se ocorrer um erro fatal, como credenciais incorretas, sem ligação ao servidor, entre outros:

"Erro ao executar a ação "List Ticket Time Entries". Motivo: {0}''.format(error.Stacktrace)

 Geral
Tabela

Nome da tabela: Freshservice Ticket <ticket id> Time Entries

Colunas da tabela:

ID da entrada de tempo

Email do agente

Nota

Faturável

Tempo despendido

ID da tarefa

Campos personalizados

Temporizador em execução

Hora de criação

Hora atualizada

Hora de início

Hora de execução

 Geral

Adicione a hora de entrada do bilhete

Descrição

Adicione uma entrada de tempo a um pedido do Freshservice. Tenha em atenção que a ação não está a funcionar em entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido Número inteiro N/A Sim Especifique o ID do pedido para o qual quer adicionar uma entrada de tempo.
Email do agente String N/A Sim Especifique o email do agente ao qual quer adicionar uma entrada de tempo do registo.
Nota String N/A Não Especifique uma nota a adicionar à entrada de tempo do registo.
Tempo despendido String N/A Sim Especifique o tempo gasto para a introdução de tempo do registo. Formato: {hh:mm}
Faturável Caixa de verificação Falso Não Se estiver ativada, a entrada de tempo do pedido é marcada como faturável.
Campos personalizados JSON N/A Não

Especifique um objeto JSON que contenha campos personalizados a adicionar à entrada de tempo do pedido. A app Action anexa novos campos personalizados a todos os existentes para um pedido. Exemplo de formato:

{"key1":"value1", "key2":"value2"}

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
   "time_entry": {
       "id": 17000405061,
       "created_at": "2021-07-10T18:22:18Z",
       "updated_at": "2021-07-10T18:22:18Z",
       "start_time": "2021-07-10T18:22:18Z",
       "timer_running": false,
       "billable": true,
       "time_spent": "01:00",
       "executed_at": "2021-07-10T18:22:18Z",
       "task_id": null,
       "note": "test_entry3",
       "agent_id": 17002188556,
       "custom_fields": {
           "test": "very_test"
       }
   }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • A nova entrada de tempo é adicionada ao pedido <ticket id>.

  • Se o ID do pedido fornecido não foi encontrado (is_success = false):

    • "Não foi encontrado o pedido <ticket id> no Freshservice.

  • Se o email do agente fornecido não foi encontrado (is_success = false):

    • "Não foi possível encontrar o agente com o email <agent_email> no Freshservice.

  • If provided time spent has a wrong format (is_success = false):

    • "O valor de tempo gasto especificado <time_spent> está no formato incorreto. Deve estar no formato "hh:mm".

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal, um erro do SDK, como credenciais incorretas, sem ligação ao servidor, ou outro: "Erro ao executar a ação "Adicionar entrada de tempo do pedido". Motivo: {0}''.format(error.Stacktrace)

 Geral

Atualize a hora de entrada do bilhete

Descrição

Atualize uma entrada de tempo para um pedido do Freshservice. Tenha em atenção que a ação não está a funcionar nas entidades do Google SecOps

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido Número inteiro N/A Sim Especifique o ID do registo para o qual quer atualizar uma entrada de tempo.
ID da entrada de tempo Número inteiro N/A Sim Especifique o ID da entrada de tempo a atualizar.
Email do agente String N/A Não Especifique o email do agente para o qual pretende alterar uma entrada de tempo de um pedido.
Nota String N/A Não Especifique uma nota para a entrada de tempo do pedido.
Tempo despendido String N/A Não Especifique o tempo gasto para a introdução de tempo do registo. Formato: {hh:mm}
Faturável Caixa de verificação Falso (não selecionado) Não Se estiver ativada, a entrada de tempo do pedido é marcada como faturável.
Campos personalizados JSON N/A Não

Especifique um objeto JSON que contenha campos personalizados a adicionar à entrada de tempo do pedido. A app Action anexa novos campos personalizados a todos os existentes para um pedido. Exemplo de formato:

{"key1":"value1", "key2":"value2"}

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Resultado JSON
{
    "time_entry": {
        "id": 17000405061,
        "created_at": "2021-07-10T18:22:18Z",
        "updated_at": "2021-07-10T18:30:54Z",
        "start_time": "2021-07-10T18:22:18Z",
        "timer_running": false,
        "billable": false,
        "time_spent": "03:30",
        "executed_at": "2021-07-10T18:22:18Z",
        "task_id": null,
        "note": "test_entry_updated",
        "agent_id": 17002188556,
        "custom_fields": {
            "test": "very_test2"
        }
    }
}
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • A entrada de tempo <time_entry_id> é atualizada para o pedido <ticket id>.

  • Se o ID do pedido ou o ID da entrada de tempo fornecido não foi encontrado (is_success = false):

    • "Não foi encontrado o ID do pedido <ticket_id> ou o ID da entrada de tempo <time_entry id> fornecido no Freshservice.

  • Se o email do agente fornecido não foi encontrado (is_success = false):

    • "Não foi possível encontrar o agente com o email <agent_email> no Freshservice.

  • If provided time spent has a wrong format (is_success = false):

    • "O valor de tempo gasto especificado <time_spent> está no formato incorreto. Deve estar no formato "hh:mm".

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal ou um erro do SDK, como credenciais incorretas, sem ligação ao servidor ou outro: "Erro ao executar a ação "Atualizar entrada de tempo do pedido". Motivo: {0}''.format(error.Stacktrace)

 Geral

Elimine a entrada de tempo do pedido

Descrição

Elimine uma entrada de tempo para um pedido do Freshservice. Tenha em atenção que a ação não está a funcionar nas entidades do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido Número inteiro N/A Sim Especifique o ID do registo para eliminar uma entrada de tempo.
ID da entrada de tempo Número inteiro N/A Sim Especifique o ID da entrada de tempo a eliminar.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor
is_success is_success=False
is_success is_success=True
Case Wall
Tipo de resultado Valor/descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

  • Se a ação for executada com êxito:(is_success=true)

    • A entrada de tempo <time_entry_id> foi eliminada para o pedido <ticket id>.

  • Se o ID do pedido ou o ID da entrada de tempo fornecido não foi encontrado (is_success = false):

    • "Não foi encontrado o ID do pedido <ticket_id> ou o ID da entrada de tempo <time_entry id> fornecido no Freshservice

A ação deve falhar e parar a execução de um guia interativo:

Se for um erro fatal, um erro do SDK, como credenciais incorretas, sem ligação ao servidor ou outro: "Erro ao executar a ação "Eliminar entrada de tempo do pedido". Motivo: {0}''.format(error.Stacktrace)

 Geral

Conetor

Conector de pedidos do Freshservice

Descrição

O conector pode ser usado para obter pedidos do Freshservice a partir dos quais criar alertas do Google SecOps. A lista de autorizações do conector pode ser usada para carregar apenas tipos específicos de pedidos: incidentes ou pedidos de serviço.

Configure o conetor de pedidos de apoio técnico do Freshservice no Google SecOps

Para ver instruções detalhadas sobre como configurar um conetor no Google SecOps, consulte o artigo Configurar o conetor.

Parâmetros do conetor

Use os seguintes parâmetros para configurar o conector:

Nome a apresentar do parâmetro Tipo Valor predefinido Is Mandatory Descrição
Nome do campo do produto String Freshworks Freshservice Sim
Nome do campo de evento String "type" Sim
Nome do campo do ambiente String "" Não Não
Padrão de regex do ambiente String .* Não Não
Raiz da API String

https://yourdomain.freshservice.com

 Sim URL raiz da API da instância do Freshservice.
Chave de API Palavra-passe N/A Sim Chave da API Freshservice a usar na integração.
Validar SSL Caixa de verificação Marcado Não Se estiver ativada, a integração tenta validar se o URL raiz está configurado com um certificado válido.
Tempo de desvio em horas Número inteiro 24 Sim Busca bilhetes de X horas para trás.
Máximo de bilhetes por ciclo Número inteiro 30 Sim Quantos registos devem ser processados durante uma execução do conector.
Prioridade mínima para obter String Médio Não Prioridade mínima do registo a ser carregado para o Google SecOps, por exemplo, Baixa ou Média. Valores possíveis: Low, Medium, High, Urgent
Estado dos bilhetes a obter CSV Aberto, fechado Não Estados dos pedidos a serem carregados para o Google SecOps. O parâmetro aceita vários valores como uma string separada por vírgulas. Valores possíveis: Open, Pending, Resolved, Closed
Use a lista de autorizações como uma lista negra Caixa de verificação Desmarcado Sim Se estiver ativada, a lista de autorizações é usada como uma lista negra.

Regras do conetor

Suporte de proxy

O conetor suporta proxy.

Empregos

Freshservice Sync Tickets Closure Job

Descrição

Encerre pedidos no Freshservice se os alertas correspondentes do Google Security Operations SOAR tiverem sido encerrados.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Raiz da API String https://yourdomain.freshservice.com Sim URL raiz da API da instância do Freshservice.
Chave de API Palavra-passe N/A Sim Chave da API Freshservice a usar na integração.
Validar SSL Caixa de verificação Marcado Não Se estiver ativada, a integração tenta validar se o URL raiz está configurado com um certificado válido.
Tempo de desvio em horas Número inteiro 24 Sim Sincronize o encerramento de pedidos X horas antes.
Descrição predefinida do pedido String O pedido é encerrado pela tarefa de encerramento de pedidos de sincronização do Siemplify Freshservice. Sim Especifique a descrição que deve ser adicionada ao pedido se este não tiver a descrição, para que possa ser fechado no Freshservice, uma vez que o campo de descrição é obrigatório para o Freshservice.

Freshservice Sync Tickets Conversations Job

Descrição

Sincronizar conversas (consideradas respostas e notas) entre o registo do alerta do Google SecOps e o pedido correspondente do Freshservice. O mecanismo de sincronização funciona nos dois sentidos: Google SecOps → Freshservice e Freshservice → Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Raiz da API String https://yourdomain.freshservice.com Sim URL raiz da API da instância do Freshservice.
Chave de API Palavra-passe N/A Sim Chave da API Freshservice a usar na integração.
Validar SSL Caixa de verificação Marcado Não Se estiver ativada, a integração tenta validar se o URL raiz está configurado com um certificado válido.
Tempo de desvio em horas Número inteiro 24 Sim Sincronize conversas de pedidos de apoio técnico X horas antes
Prefixo de comentário do Siemplify String SIEMPLIFY: Sim Prefixo que a tarefa de sincronização adiciona aos comentários criados para pedidos do Freshservice.
Prefixo de comentários do Freshservice String Tarefa de sincronização de comentários do Freshservice: Sim Prefixo que a tarefa de sincronização adiciona aos comentários do registo de alertas do Google SecOps.
Tipos de conversas a sincronizar CSV Respostas, notas Sim Especifique os tipos de conversas do Freshservice que o trabalho deve sincronizar. O parâmetro aceita vários valores como uma string separada por vírgulas.
Obter notas privadas? Caixa de verificação Caixa de verificação desmarcada (falso) Não Se estiver ativada, obtém notas públicas e privadas para pedidos relacionados do Freshservice.
Sincronize o comentário do Siemplify como X String Nota privada Sim Especifique que tipo de conversa o trabalho deve usar para adicionar um comentário do Google SecOps. Valores possíveis: nota privada, nota pública, resposta.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais da Google SecOps.