Freshworks Freshservice

Version de l'intégration : 14.0

Cas d'utilisation

Intégration au centre de services.

Configuration de Freshservice

L'intégration de Freshservice à Google Security Operations fonctionne sur la base des clés API Freshservice.

Obtenir la clé API du compte dans Freshservice

  1. Se connecter au portail d'assistance Freshservice
  2. Cliquez sur la photo de profil du compte en haut à droite de votre portail.
  3. Accéder à la page des paramètres du profil
  4. La clé API du compte sera disponible à droite de la section "Modifier le mot de passe".
  5. Enregistrez cette clé API, car vous en aurez besoin pour configurer l'intégration Google SecOps.

Configurer l'intégration de Freshworks Freshservice dans Google SecOps

Pour obtenir des instructions détaillées sur la configuration d'une intégration dans Google SecOps, consultez Configurer des intégrations.

Paramètres d'intégration

Utilisez les paramètres suivants pour configurer l'intégration :

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
Racine de l'API Chaîne https://yourdomain.freshservice.com Oui URL racine de l'API de l'instance Freshservice.
Clé API Mot de passe N/A Oui Clé API Freshservice à utiliser dans l'intégration.
Vérifier le protocole SSL Case à cocher Cochée Non Si elle est activée, l'intégration vérifie que l'URL racine est configurée avec un certificat valide.

Actions

Ping

Description

Testez la connectivité à l'instance Freshservice avec les paramètres fournis sur la page de configuration de l'intégration dans l'onglet "Google Security Operations Marketplace".

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Mur des cas
Type de résultat Valeur / Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • En cas de succès : "Connexion à l'instance Freshservice établie avec succès à l'aide des paramètres de connexion fournis !"

L'action doit échouer et arrêter l'exécution d'un playbook en cas d'erreur critique, comme des identifiants incorrects ou une perte de connectivité : "Échec de la connexion à l'instance Freshservice. Error is {0}".format(exception.stacktrace)

 Général

Lister les billets

Description

Lister les tickets Freshservice en fonction des critères de recherche spécifiés. Notez que l'action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
Type de billet LDD Tous Non Spécifiez le type de billet à renvoyer.
Demandeur Chaîne N/A Non Spécifiez l'adresse e-mail du demandeur des tickets à renvoyer.
Inclure les statistiques Case à cocher Décochée Non Si cette option est activée, l'action renvoie des statistiques supplémentaires sur les billets.
Rechercher les X dernières heures Integer N/A Non Spécifiez la période pour laquelle rechercher des billets.
Lignes par page Integer 30 Non Spécifiez le nombre de demandes à renvoyer par page pour la pagination Freshservice.
Commencer à la page Integer 1 Non Indiquez à partir de quelle page les tickets doivent être renvoyés avec la pagination Freshservice.
Nombre maximal de lignes à renvoyer Integer 30 Non Spécifiez le nombre total de billets que l'action doit renvoyer.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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
            }
        }
    ]
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si des demandes d'assistance ont été trouvées (is_success = true) : "Demandes Freshservice récupérées"
  • Si aucun billet n'est renvoyé (is_success = false) : "Aucun billet n'a été trouvé pour les paramètres d'entrée fournis."
  • Si vous avez reçu une erreur d'API lors de la récupération des billets (is_success = false) : "Échec de la liste des billets avec les paramètres d'entrée fournis. Erreur : {error from the API}"

L'action doit échouer et arrêter l'exécution d'un playbook :

Si une erreur fatale se produit (par exemple, des identifiants incorrects, une absence de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Lister les tickets". Raison : {0}''.format(error.Stacktrace)

 Général
Table

Nom de la table : Tickets Freshservice trouvés

Colonnes du tableau :

ID

Type

Objet

Description

Adresse e-mail du demandeur

Catégorie

État

Priorité

Source

Date de création

Date de mise à jour

Date limite

Escaladé

Supprimé

 Général

Créer une demande

Description

Créez une demande Freshservice.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
Subject Chaîne N/A Oui Spécifiez le champ "Objet" pour la demande créée.
Description Chaîne N/A Oui Spécifiez le champ de description pour le ticket créé.
Adresse e-mail du demandeur Chaîne N/A Oui Spécifiez l'adresse e-mail du demandeur pour le ticket créé.
Attribuer à l'agent Chaîne N/A Non Spécifiez l'adresse e-mail de l'agent auquel attribuer la demande.
Attribuer à un groupe Chaîne N/A Non Indiquez le nom du groupe auquel attribuer la demande.
Priorité LDD Moyenne Oui Spécifiez la priorité à attribuer à la demande.
Urgence LDD Moyenne Non Spécifiez l'urgence à attribuer à la demande.
Impact LDD Moyenne Non Spécifiez l'impact à attribuer à la demande.
Tags Chaîne N/A Non Spécifiez les tags à attribuer à la demande. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules.
Champs personnalisés JSON N/A Non

Spécifiez un objet JSON contenant les champs personnalisés à ajouter à la demande. Acton ajoute de nouveaux champs personnalisés à ceux qui existent déjà pour un ticket. Exemple de format :

{"key1":"value1", "key2":"value2"}
Pièces jointes à ajouter Chaîne (CSV) N/A Non Spécifiez le chemin d'accès complet au fichier à importer avec la demande. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules. La taille totale des pièces jointes ne doit pas dépasser 15 Mo.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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": []
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'exécute correctement (is_success=true) : un nouveau ticket Freshservice a été créé.

  • Si l'action n'a pas pu s'exécuter en raison des paramètres fournis(is_success =false) : "Échec de la création de la demande avec les paramètres fournis. Erreur : <texte de l'erreur>."

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, identifiants incorrects, pas de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Créer un ticket". Raison : {0}''.format(error.Stacktrace)

 Général

Modifier un billet

Description

Mettez à jour un ticket Freshservice en fonction des paramètres d'entrée de l'action fournis. Notez que si de nouveaux tags sont fournis pour la demande, en raison des limites de l'API Freshservice, l'action remplace les tags existants dans la demande, et n'en ajoute pas de nouveaux.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de la demande Integer N/A Oui Spécifiez l'ID du ticket à modifier.
État LDD Aucune modification Non Spécifiez le nouvel état de la demande.
Objet Chaîne N/A Non Spécifiez le champ "Objet" à modifier.
Description Chaîne N/A Non Spécifiez le champ de description à mettre à jour.
Adresse e-mail du demandeur Chaîne N/A Non Spécifiez l'adresse e-mail du demandeur à modifier.
Attribuer à l'agent Chaîne N/A Non Spécifiez l'adresse e-mail de l'agent à modifier.
Attribuer à un groupe Chaîne N/A Non Indiquez le nom du groupe à modifier.
Priorité LDD Non modifiée Non Spécifiez la priorité à modifier.
Urgence LDD Non modifiée Non Indiquez l'urgence de la mise à jour.
Impact LDD Non modifiée Non Spécifiez l'impact à modifier.
Tags Chaîne N/A Non Spécifiez les tags à remplacer dans la demande. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules. Notez qu'en raison des limites de l'API Freshservice, l'action remplace les tags existants dans la demande, et n'en ajoute pas de nouveaux.
Champs personnalisés JSON N/A Non

Spécifiez un objet JSON contenant les champs personnalisés à ajouter à la demande. Acton ajoute de nouveaux champs personnalisés à ceux qui existent déjà pour un ticket. Exemple de format :

{"key1":"value1", "key2":"value2"}
Pièces jointes à ajouter Chaîne (CSV) N/A Non Spécifiez le chemin d'accès complet au fichier à importer avec la demande. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules. La taille totale des pièces jointes ne doit pas dépasser 15 Mo.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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": []
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • La demande Freshservice <ticket id> a été mise à jour.

  • Si l'action n'a pas pu s'exécuter en raison des paramètres fournis(is_success =false)

    • Échec de la mise à jour de la demande <ticket_id> avec les paramètres fournis. Erreur : <error text>.

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, identifiants incorrects, pas de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Mettre à jour la demande". Raison : {0}''.format(error.Stacktrace)

 Général

Lister les conversations de demandes

Description

Lister les conversations des tickets Freshservice en fonction des critères de recherche spécifiés. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de la demande Integer N/A Oui Spécifiez l'ID du ticket pour lequel renvoyer les conversations.
Lignes par page Integer 30 Non Indiquez le nombre de conversations de demandes à renvoyer par page pour la pagination Freshservice.
Commencer à la page Integer 1 Non Spécifiez à partir de quelle page les conversations sur les demandes doivent être renvoyées avec la pagination Freshservice.
Nombre maximal de lignes à renvoyer Integer 30 Non Spécifiez le nombre total de conversations sur les tickets que l'action doit renvoyer.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si des conversations de tickets ont été trouvées (is_success = true) :
    "Les conversations du ticket Freshservice <ticket id> ont bien été récupérées."
  • Si aucune conversation de ticket n'est renvoyée (is_success = false) :
    "Aucune conversation de ticket n'a été trouvée pour le ticket <ticket id>"
  • Si l'ID de demande fourni est introuvable (is_success = false) :
    "La demande <ticket id> est introuvable dans Freshservice.
  • Si vous avez reçu une erreur d'API lors de la récupération des tickets (is_success = false) : "Échec de la liste des conversations de tickets avec les paramètres d'entrée fournis. Erreur : {error from the API}"

L'action doit échouer et arrêter l'exécution d'un playbook :

Si une erreur fatale s'est produite (par exemple, des identifiants incorrects, une absence de connexion au serveur, etc.) :

"Erreur lors de l'exécution de l'action "Lister les conversations de demande". Raison : {0}''.format(error.Stacktrace)

 Général
Table

Nom de la table : Conversations Freshservice Ticket <ticket id>

Colonnes du tableau :

ID

Type

Visibilité

Adresse e-mail de l'utilisateur

Texte

From Email

Adresse e-mail du destinataire

Adresse e-mail en copie

Adresse e-mail en Cci

 Général

Ajouter une réponse à un ticket

Description

Ajoutez une réponse à une demande Freshservice. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de la demande Integer N/A Oui Spécifiez l'ID du ticket pour lequel renvoyer les conversations.
Texte de la réponse Chaîne N/A Oui Spécifiez le texte de la réponse à ajouter à la demande.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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"
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • Une nouvelle réponse a été ajoutée à la demande <ticket id>.

  • Si l'ID du titre de transport fourni est introuvable (is_success = false) :

    • "Le ticket <ticket id> est introuvable dans Freshservice.

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, identifiants incorrects, pas de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Ajouter une réponse au ticket". Raison : {0}''.format(error.Stacktrace)

 Général

Ajouter une note à un billet

Description

Ajoutez une note à une demande Freshservice. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de la demande Integer N/A Oui Spécifiez l'ID du ticket pour lequel renvoyer les conversations.
Type de note LDD Privé Non Spécifiez le type d'action de note à ajouter à la demande.
Texte de la note Chaîne N/A Oui Spécifiez le texte de la note à ajouter à la demande.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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"
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • Une nouvelle note <note type> a été ajoutée à la demande <ticket id>.

  • Si l'ID du titre de transport fourni est introuvable (is_success = false) :

    • "Le ticket <ticket id> est introuvable dans Freshservice.

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, identifiants incorrects, pas de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Ajouter une note au ticket". Raison : {0}''.format(error.Stacktrace)

 Général

Répertorier les agents

Description

Lister les agents Freshservice en fonction des critères de recherche spécifiés. Notez que l'action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
Adresse e-mail de l'agent Chaîne N/A Non Spécifiez l'adresse e-mail pour laquelle renvoyer les enregistrements d'agent.
État de l'agent LDD TOUT Non Spécifiez les états d'agent à renvoyer.
Inclure les agents non actifs Case à cocher Décochée Non Si cette option est activée, les résultats incluront les enregistrements des agents inactifs.
Lignes par page Integer 30 Non Indiquez le nombre d'enregistrements d'agents à renvoyer par page pour la pagination Freshservice.
Commencer à la page Integer 1 Non Spécifiez à partir de quelle page les enregistrements d'agent doivent être renvoyés avec la pagination Freshservice.
Nombre maximal de lignes à renvoyer Integer 30 Non Spécifiez le nombre total d'enregistrements d'agents que l'action doit renvoyer.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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": []
        },
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si des agents ont été trouvés (is_success = true) : "Récupération des agents Freshservice réussie."
  • Si aucun agent n'est renvoyé (is_success = false) : "Aucun agent n'a été trouvé pour les paramètres d'entrée fournis."
  • Si vous avez reçu une erreur d'API lors de la récupération des agents (is_success = false) : "Échec de la liste des agents avec les paramètres d'entrée fournis. Erreur : {error from the API}"

L'action doit échouer et arrêter l'exécution d'un playbook :

Si une erreur fatale s'est produite (par exemple, des identifiants incorrects, une absence de connexion au serveur, etc.) :

"Erreur lors de l'exécution de l'action "Lister les agents". Raison : {0}''.format(error.Stacktrace)

 Général

Tableau

Nom de la table : Agents Freshservice trouvés

Colonnes du tableau :

ID

E-mail

Prénom

Nom

Rôles

Groupes

Services

Emplacement

Actif

Occasionnel

Champs personnalisés

Date de création

Date de mise à jour

Date de dernière activité

Date de la dernière connexion

 Général

Lister les demandeurs

Description

Lister les demandeurs enregistrés dans Freshservice en fonction des critères de recherche spécifiés. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
Adresse e-mail du demandeur Chaîne N/A Non Spécifiez l'adresse e-mail pour laquelle renvoyer les enregistrements du demandeur.
Lignes par page Integer 30 Non Indiquez le nombre d'enregistrements d'agents à renvoyer par page pour la pagination Freshservice.
Commencer à la page Integer 1 Non Spécifiez à partir de quelle page les enregistrements d'agent doivent être renvoyés avec la pagination Freshservice.
Nombre maximal de lignes à renvoyer Integer 30 Non Spécifiez le nombre total d'enregistrements d'agents que l'action doit renvoyer.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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
        }
    ]
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si des demandeurs sont trouvés (is_success = true) :
    "Successfully fetched Freshservice registered requesters."
  • Si aucun demandeur n'est renvoyé (is_success = false) :
    "Aucun demandeur n'a été trouvé pour les paramètres d'entrée fournis."
  • Si vous avez reçu une erreur d'API lors de la récupération des demandeurs (is_success = false) : "Échec de la liste des demandeurs avec les paramètres d'entrée fournis. Erreur : {error from the API}"

L'action doit échouer et arrêter l'exécution d'un playbook :

Si une erreur fatale s'est produite (par exemple, des identifiants incorrects, une absence de connexion au serveur, etc.) :

"Erreur lors de l'exécution de l'action "Lister les demandeurs". Raison : {0}''.format(error.Stacktrace)

 Général

Tableau

Nom de la table : Freshservice Requester Found

Colonnes du tableau :

ID

E-mail

Prénom

Nom

Services

Emplacement

Actif

Champs personnalisés

Date de création

Date de mise à jour

 Général

Créer un agent

Description

Créez un agent Freshservice. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
E-mail Chaîne N/A Oui Spécifiez l'adresse e-mail de l'agent à créer.
Prénom Chaîne N/A Oui Spécifiez le prénom de l'agent à créer.
Nom Chaîne N/A Non Spécifiez le nom de famille de l'agent à créer.
Est occasionnelle Case à cocher Décochée Non Si cette option est activée, l'agent sera créé en tant qu'agent occasionnel. Sinon, il sera créé en tant qu'agent à temps plein.
Peut voir tous les tickets des services associés Case à cocher Décochée Non

Si cette option est activée, l'agent pourra voir tous les tickets des services associés.
Services CSV N/A Non Spécifiez les noms des services associés à l'agent. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules.
Emplacement Chaîne N/A Non Spécifiez le nom du lieu associé à l'agent.
Abonnements aux groupes CSV N/A Non Spécifiez les noms des groupes auxquels l'agent doit appartenir.
Rôles CSV N/A Oui

Spécifiez les rôles à ajouter à l'agent. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules.

Exemple : {"role_id":17000023338,"assignment_scope": ""}
Fonction Chaîne N/A Non Spécifiez la fonction de l'agent.
Champs personnalisés JSON N/A Non

Spécifiez un objet JSON contenant les champs personnalisés à ajouter à l'agent. Acton ajoute de nouveaux champs personnalisés à ceux qui existent déjà pour un ticket. Exemple de format :

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

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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": []
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • Un nouvel agent Freshservice a été créé.

  • Si l'action n'a pas pu s'exécuter en raison des paramètres fournis(is_success =false)

    • Échec de la création de l'agent avec les paramètres fournis. Erreur : <error text>.

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, identifiants incorrects, pas de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Créer un agent". Raison : {0}''.format(error.Stacktrace)

 Général

Mettre à jour l'agent

Description

Mettez à jour l'agent Freshservice existant. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de l'agent Integer N/A Oui Spécifiez l'ID de l'agent à mettre à jour.
E-mail Chaîne N/A Non Spécifiez l'adresse e-mail de l'agent à modifier.
Prénom Chaîne N/A Non Spécifiez le prénom de l'agent à modifier.
Nom Chaîne N/A Non Spécifiez le nom de famille de l'agent à modifier.
Est occasionnelle Case à cocher Décochée Non Si cette option est activée, l'agent sera mis à jour en tant qu'agent occasionnel. Sinon, il sera considéré comme un agent à temps plein.
Peut voir tous les tickets des services associés Case à cocher Décochée Non

Si cette option est activée, l'agent pourra voir tous les tickets des services associés.
Services CSV N/A Non Spécifiez les noms des services associés à l'agent. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules.
Emplacement Chaîne N/A Non Spécifiez le nom du lieu associé à l'agent.
Abonnements aux groupes CSV N/A Non Spécifiez les noms des groupes auxquels l'agent doit appartenir.
Rôles CSV N/A Non

Spécifiez les rôles à ajouter à l'agent. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules.

Exemple : {"role_id":17000023338,"assignment_scope": "entire_helpdesk"}
Fonction Chaîne N/A Non Spécifiez la fonction de l'agent.
Champs personnalisés JSON N/A Non

Spécifiez un objet JSON contenant les champs personnalisés à ajouter à l'agent. Acton ajoute de nouveaux champs personnalisés à ceux qui existent déjà pour un ticket. Exemple de format :

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

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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": []
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • L'agent Freshservice <agent_id> a été mis à jour.

  • Si l'action n'a pas pu s'exécuter en raison des paramètres fournis(is_success =false)

    • Échec de la mise à jour de l'agent Freshservice <agent_id> avec les paramètres fournis. Erreur : <error text>.

L'action doit échouer et arrêter l'exécution d'un playbook :

if fatal error, SDK error, like wrong credentials, no connection to server, other: "Error executing action "Update Agent". Raison : {0}''.format(error.Stacktrace)

 Général

Désactiver l'agent

Description

Désactivez l'agent Freshservice. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de l'agent Integer N/A Oui Spécifiez l'ID de l'agent à désactiver.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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": []
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • L'agent Freshservice <agent_id> est désactivé.

  • Si l'action n'a pas pu être exécutée en raison de l'erreur 404 (is_success =false)

    • Échec de la recherche de l'agent Freshservice <agent_id> à désactiver.

  • Si l'action n'a pas pu s'exécuter en raison de l'erreur 403 (is_success =false)

    • Échec de la désactivation de l'agent Freshservice <agent_id>. Il est peut-être déjà désactivé. Réponse de l'API : "code": "access_denied","message": "You are not authorized to perform this action." (code : access_denied, message : Vous n'êtes pas autorisé à effectuer cette opération)

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, des identifiants incorrects, une absence de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Désactiver l'agent". Raison : {0}''.format(error.Stacktrace)

 Général

Créer un demandeur

Description

Créez un demandeur Freshservice. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
E-mail Chaîne N/A Oui Spécifiez l'adresse e-mail du demandeur à créer.
Prénom Chaîne N/A Oui Spécifiez le prénom du demandeur à créer.
Nom Chaîne N/A Non Spécifiez le nom de famille du demandeur à créer.
Peut voir tous les tickets des services associés Case à cocher Décochée Non

Si cette option est activée, le demandeur pourra voir tous les tickets des services associés.
Services CSV N/A Non Spécifiez les noms des services associés au demandeur . Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules.
Emplacement Chaîne N/A Non Spécifiez le nom du lieu associé au demandeur .
Fonction Chaîne N/A Non Indiquez la fonction du demandeur.
Champs personnalisés JSON N/A Non

Spécifiez un objet JSON contenant les champs personnalisés à ajouter au demandeur. Acton ajoute de nouveaux champs personnalisés à ceux qui existent déjà pour un ticket. Exemple de format :

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

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • Un nouveau demandeur Freshservice a été créé.

  • Si l'action n'a pas pu s'exécuter en raison des paramètres fournis(is_success =false)

    • Échec de la création du demandeur avec les paramètres fournis. Erreur : <texte de l'erreur>.

L'action doit échouer et arrêter l'exécution d'un playbook :

if fatal error, SDK error, like wrong credentials, no connection to server, other: "Error executing action "Create Requester". Raison : {0}''.format(error.Stacktrace)

 Général

Modifier le demandeur

Description

Mettez à jour un demandeur Freshservice existant. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID du demandeur Integer N/A Oui Spécifiez l'ID du demandeur à mettre à jour.
E-mail Chaîne N/A Non Spécifiez l'adresse e-mail du demandeur à modifier.
Prénom Chaîne N/A Non Spécifiez le prénom du demandeur à modifier.
Nom Chaîne N/A Non Spécifiez le nom de famille du demandeur à modifier.
Peut voir tous les tickets des services associés Case à cocher Décochée Non

Si cette option est activée, le demandeur pourra voir tous les tickets des services associés.
Services CSV N/A Non Spécifiez les noms des services associés au demandeur. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules.
Emplacement Chaîne N/A Non Spécifiez le nom du lieu associé au demandeur.
Fonction Chaîne N/A Non Indiquez la fonction du demandeur.
Champs personnalisés JSON N/A Non

Spécifiez un objet JSON contenant les champs personnalisés à ajouter au demandeur. Acton ajoute de nouveaux champs personnalisés à ceux qui existent déjà pour un ticket. Exemple de format :

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

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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": []
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • La demande Freshservice <requester_id> a été mise à jour.

  • Si l'action n'a pas pu s'exécuter en raison des paramètres fournis(is_success =false)

    • Échec de la mise à jour du demandeur Freshservice <requester_id> avec les paramètres fournis. Erreur : <error text>.

L'action doit échouer et arrêter l'exécution d'un playbook :

if fatal error, SDK error, like wrong credentials, no connection to server, other: "Error executing action "Update Requester". Raison : {0}''.format(error.Stacktrace)

 Général

Désactiver le demandeur

Description

Désactivez le demandeur Freshservice. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID du demandeur Integer N/A Oui Spécifiez l'ID du demandeur à désactiver.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • Le demandeur Freshservice <requester_id> est désactivé.

  • Si l'action n'a pas pu être exécutée en raison de l'erreur 404 (is_success =false)

    • Échec de la recherche du demandeur Freshservice <requester_id> à désactiver.

  • Si l'action n'a pas pu être exécutée en raison de l'erreur 405 (is_success =false)

    • Échec de la désactivation du demandeur Freshservice <requester_id>. Peut-être a-t-il déjà été désactivé ? Réponse de l'API : "message": "DELETE method is not allowed. Il doit s'agir de l'une des méthodes suivantes : GET"

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, identifiants incorrects, pas de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Désactiver le demandeur". Raison : {0}''.format(error.Stacktrace)

 Général

Lister les entrées de temps des tickets

Description

Lister les entrées de temps des tickets Freshservice en fonction des critères de recherche spécifiés. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de la demande Integer N/A Oui Spécifiez l'ID du ticket pour lequel renvoyer les entrées de temps.
Adresse e-mail de l'agent Chaîne N/A Oui Spécifiez l'adresse e-mail de l'agent pour lequel vous souhaitez lister les entrées de temps des demandes.
Lignes par page Integer 30 Non Indiquez le nombre d'entrées de temps de ticket à renvoyer par page pour la pagination Freshservice.
Commencer à la page Integer 1 Non Indiquez à partir de quelle page les entrées de temps des tickets doivent être renvoyées avec la pagination Freshservice.
Nombre maximal de lignes à renvoyer Integer 30 Non Spécifiez le nombre total d'entrées de temps de ticket que l'action doit renvoyer.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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": {}
       }
   ]
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si des entrées de temps ont été trouvées pour le ticket (is_success = true) :
    "Les entrées de temps du ticket Freshservice <ticket id> ont bien été récupérées."
  • Si aucune entrée de temps n'est renvoyée pour le ticket (is_success = false) :
    "Aucune entrée de temps n'a été trouvée pour le ticket <ticket id>"
  • Si l'ID de demande fourni est introuvable (is_success = false) :
    "La demande <ticket id> est introuvable dans Freshservice.
  • Si aucun ID d'agent n'a été trouvé pour l'adresse e-mail de l'agent fournie (is_success = false) :
    "L'agent <agent_email> n'a pas été trouvé dans Freshservice.
  • Si une erreur d'API s'est produite lors de la récupération des entrées de temps du ticket (is_success = false) : "Échec de la liste des entrées de temps du ticket avec les paramètres d'entrée fournis. Erreur : {error from the API}"

L'action doit échouer et arrêter l'exécution d'un playbook :

Si une erreur fatale s'est produite (par exemple, des identifiants incorrects, une absence de connexion au serveur, etc.) :

"Erreur lors de l'exécution de l'action "Lister les entrées de temps des tickets". Raison : {0}''.format(error.Stacktrace)

 Général
Table

Nom de la table : "Freshservice Ticket <ticket id> Time Entries"

Colonnes du tableau :

ID de la saisie de temps

Adresse e-mail de l'agent

Remarque

Facturable

Temps passé

ID de la tâche

Champs personnalisés

Minuteur en cours

Heure de création

Date et heure de mise à jour

Heure de début

Heure d'exécution

 Général

Ajouter une saisie de temps pour un ticket

Description

Ajoutez une entrée de temps à un ticket Freshservice. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de la demande Integer N/A Oui Spécifiez l'ID du ticket pour lequel ajouter une entrée de temps.
Adresse e-mail de l'agent Chaîne N/A Oui Spécifiez l'adresse e-mail de l'agent pour lequel ajouter une entrée de temps pour un ticket.
Remarque Chaîne N/A Non Spécifiez une note à ajouter à l'entrée de temps du ticket.
Temps passé Chaîne N/A Oui Spécifiez le temps passé pour l'enregistrement du temps consacré à un ticket. Format : {hh:mm}
Facturable Case à cocher Faux Non Si cette option est activée, les saisies de temps des tickets seront marquées comme facturables.
Champs personnalisés JSON N/A Non

Spécifiez un objet JSON contenant les champs personnalisés à ajouter à la saisie de temps du ticket. Acton ajoute de nouveaux champs personnalisés à ceux qui existent déjà pour un ticket. Exemple de format :

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

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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"
       }
   }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • Une nouvelle saisie de temps a été ajoutée à la demande <ticket id>.

  • Si l'ID du titre de transport fourni est introuvable (is_success = false) :

    • "Le ticket <ticket id> est introuvable dans Freshservice.

  • Si l'adresse e-mail de l'agent fournie n'a pas été trouvée (is_success = false) :

    • "L'agent associé à l'adresse e-mail <agent_email> est introuvable dans Freshservice.

  • Si le format du temps passé fourni est incorrect (is_success = false) :

    • "La valeur de temps passé <time_spent> spécifiée n'est pas au bon format. Elle doit être au format 'hh:mm'.

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, identifiants incorrects, pas de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Ajouter une saisie de temps pour le ticket". Raison : {0}''.format(error.Stacktrace)

 Général

Modifier une saisie de temps pour une demande

Description

Mettez à jour une saisie de temps pour un ticket Freshservice. Notez que l'action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de la demande Integer N/A Oui Spécifiez l'ID du ticket pour lequel vous souhaitez modifier une entrée de temps.
ID de la saisie de temps Integer N/A Oui Spécifiez l'ID de la saisie de temps à modifier.
Adresse e-mail de l'agent Chaîne N/A Non Spécifiez l'adresse e-mail de l'agent pour lequel modifier une entrée de temps d'un ticket.
Remarque Chaîne N/A Non Spécifiez une note pour la saisie de temps de la demande.
Temps passé Chaîne N/A Non Spécifiez le temps passé pour l'enregistrement du temps consacré à un ticket. Format : {hh:mm}
Facturable Case à cocher Faux (non coché) Non Si cette option est activée, les saisies de temps des tickets seront marquées comme facturables.
Champs personnalisés JSON N/A Non

Spécifiez un objet JSON contenant les champs personnalisés à ajouter à la saisie de temps du ticket. Acton ajoute de nouveaux champs personnalisés à ceux qui existent déjà pour un ticket. Exemple de format :

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

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Résultat 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"
        }
    }
}
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • La saisie de temps <time_entry_id> a été modifiée pour la demande <ticket id>.

  • Si l'ID de demande ou l'ID de saisie de temps fourni n'a pas été trouvé (is_success = false) :

    • "L'ID de demande <ticket_id> ou l'ID de saisie de temps <time_entry id> fourni n'a pas été trouvé dans Freshservice.

  • Si l'adresse e-mail de l'agent fournie n'a pas été trouvée (is_success = false) :

    • "L'agent associé à l'adresse e-mail <agent_email> est introuvable dans Freshservice.

  • Si le format du temps passé fourni est incorrect (is_success = false) :

    • "La valeur de temps passé <time_spent> spécifiée n'est pas au bon format. Elle doit être au format 'hh:mm'.

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, identifiants incorrects, pas de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Mettre à jour la saisie de temps du ticket". Raison : {0}''.format(error.Stacktrace)

 Général

Supprimer une saisie de temps pour un ticket

Description

Supprimez une entrée de temps pour un ticket Freshservice. Notez que cette action ne fonctionne pas sur les entités Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
ID de la demande Integer N/A Oui Spécifiez l'ID du ticket pour lequel supprimer une entrée de temps.
ID de la saisie de temps Integer N/A Oui Spécifiez l'ID de l'entrée de temps à supprimer.

Exécuter sur

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur
is_success is_success=False
is_success is_success=True
Mur des cas
Type de résultat Valeur/Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

  • Si l'action s'est exécutée correctement (is_success=true) :

    • La saisie de temps <time_entry_id> a été supprimée pour la demande <ticket id>.

  • Si l'ID de demande ou l'ID de saisie de temps fourni n'a pas été trouvé (is_success = false) :

    • "L'ID de demande <ticket_id> ou l'ID de saisie de temps <time_entry id> fourni n'a pas été trouvé dans Freshservice

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'erreur est fatale ou liée au SDK (par exemple, des identifiants incorrects, une absence de connexion au serveur, etc.) : "Erreur lors de l'exécution de l'action "Supprimer l'entrée de temps du ticket". Raison : {0}''.format(error.Stacktrace)

 Général

Connecteur

Connecteur Freshservice Tickets

Description

Le connecteur peut être utilisé pour extraire les tickets Freshservice afin de créer des alertes Google SecOps. La liste d'autorisation des connecteurs peut être utilisée pour ingérer uniquement des types de demandes spécifiques : incidents ou demandes de service.

Configurer le connecteur Freshservice Tickets dans Google SecOps

Pour obtenir des instructions détaillées sur la configuration d'un connecteur dans Google SecOps, consultez Configurer le connecteur.

Paramètres du connecteur

Utilisez les paramètres suivants pour configurer le connecteur :

Nom à afficher du paramètre Type Valeur par défaut Obligatoire Description
Nom du champ de produit Chaîne Freshworks Freshservice Oui
Nom du champ d'événement Chaîne "type" Oui
Nom du champ "Environnement" Chaîne "" Non Non
Modèle d'expression régulière de l'environnement Chaîne .* Non Non
Racine de l'API Chaîne

https://yourdomain.freshservice.com

 Oui URL racine de l'API de l'instance Freshservice.
Clé API Mot de passe N/A Oui Clé API Freshservice à utiliser dans l'intégration.
Vérifier le protocole SSL Case à cocher Cochée Non Si cette option est activée, l'intégration tentera de vérifier que l'URL racine est configurée avec un certificat valide.
Décalage horaire en heures Integer 24 Oui Récupérer les billets des X dernières heures.
Nombre maximal de billets par cycle Integer 30 Oui Nombre de demandes à traiter lors d'une exécution du connecteur.
Priorité minimale pour la récupération Chaîne Moyenne Non Priorité minimale du ticket à ingérer dans Google SecOps (par exemple, "Faible" ou "Moyenne"). Valeurs possibles : "Faible", "Moyenne", "Élevée", "Urgente"
État des billets à récupérer CSV Ouvert, Fermé Non États des tickets à ingérer dans Google SecOps. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par des virgules. Valeurs possibles : "Ouvert", "En attente", "Résolu", "Fermé"
Utiliser la liste blanche comme liste noire Case à cocher Décochée Oui Si cette option est activée, la liste blanche sera utilisée comme liste noire.

Règles du connecteur

Assistance de proxy

Le connecteur est compatible avec le proxy.

Jobs

Tâche de clôture des tickets de synchronisation Freshservice

Description

Fermez les demandes dans Freshservice si les alertes Google Security Operations SOAR correspondantes ont été fermées.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
Racine de l'API Chaîne https://yourdomain.freshservice.com Oui URL racine de l'API de l'instance Freshservice.
Clé API Mot de passe N/A Oui Clé API Freshservice à utiliser dans l'intégration.
Vérifier le protocole SSL Case à cocher Cochée Non Si cette option est activée, l'intégration tentera de vérifier que l'URL racine est configurée avec un certificat valide.
Décalage horaire en heures Integer 24 Oui Synchroniser la clôture des demandes depuis X heures.
Description par défaut de la demande Chaîne La demande est clôturée par le job de clôture des demandes de synchronisation Siemplify Freshservice. Oui Indiquez la description à ajouter au ticket s'il n'en comporte pas, afin qu'il puisse être clôturé dans Freshservice, car le champ de description est obligatoire pour Freshservice.

Tâche de synchronisation des conversations de tickets Freshservice

Description

Synchronisez les conversations (réponses et notes) entre la demande d'alerte Google SecOps et le ticket Freshservice correspondant. Le mécanisme de synchronisation fonctionne dans les deux sens : Google SecOps → Freshservice et Freshservice → Google SecOps.

Paramètres

Nom du paramètre à afficher Type Valeur par défaut Obligatoire Description
Racine de l'API Chaîne https://yourdomain.freshservice.com Oui URL racine de l'API de l'instance Freshservice.
Clé API Mot de passe N/A Oui Clé API Freshservice à utiliser dans l'intégration.
Vérifier le protocole SSL Case à cocher Cochée Non Si cette option est activée, l'intégration tentera de vérifier que l'URL racine est configurée avec un certificat valide.
Décalage horaire en heures Integer 24 Oui Synchroniser les conversations des demandes depuis X heures
Préfixe de commentaire Siemplify Chaîne SIEMPLIFY : Oui Préfixe qui sera ajouté par le job de synchronisation aux commentaires créés pour les tickets Freshservice.
Préfixe de commentaire Freshservice Chaîne Tâche de synchronisation des commentaires Freshservice : Oui Préfixe qui sera ajouté par le job de synchronisation aux commentaires de la demande d'alerte Google SecOps.
Types de conversations à synchroniser CSV Réponses, Notes Oui Spécifiez les types de conversations Freshservice que le job doit synchroniser. Le paramètre accepte plusieurs valeurs sous forme de chaîne séparée par une virgule.
Récupérer les notes privées ? Case à cocher Case non cochée (false) Non Si cette option est activée, les notes publiques et privées des tickets Freshservice associés seront récupérées.
Synchroniser le commentaire depuis Siemplify en tant que X Chaîne Note privée Oui Spécifiez le type de conversation que le job doit utiliser pour ajouter un commentaire de Google SecOps. Valeurs possibles : "Note privée", "Note publique", "Réponse".

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.