Point de terminaison (endpoint) de support personnalisé

Aperçu

Cet article explique comment connecter un point de terminaison de support personnalisé à Ferndesk. Cette fonctionnalité vous permet d'intégrer votre propre système de tickets ou de support, même s'il n'est pas nativement pris en charge par Ferndesk.

Conditions préalables

• Vous devez disposer d'une URL accessible publiquement qui renvoie une réponse JSON.

• Vous devez disposer des autorisations nécessaires pour gérer les intégrations dans Ferndesk.

Étapes

1. Accédez à la page Integrations dans vos paramètres Ferndesk.

2. Cliquez sur le bouton « Add Integration ». Cela vous mènera à la page Connect an integration.

3. Sélectionnez « Support Endpoint » dans la liste des intégrations disponibles.

4. Dans la boîte de dialogue de configuration, vous verrez un champ intitulé « Source URL ».

5. Saisissez l'URL de votre point de terminaison de support personnalisé. Le texte d'espace réservé pour ce champ est https://company.com/support-endpoint.json?startDate=2025-01-01.

6. Cliquez sur le bouton « Save » pour connecter le point de terminaison.

Vérifier la configuration

Une fois votre point de terminaison de support personnalisé connecté, vous pouvez vérifier son bon fonctionnement en créant un audit. Si la connexion réussit, les conversations de votre système de support personnalisé devraient figurer dans l'audit.

Format JSON

Le point de terminaison de support personnalisé doit renvoyer une réponse JSON avec un format spécifique. L'objet racine doit contenir une clé conversations, qui contient un tableau d'objets de conversation. Chaque objet de conversation doit avoir un id, un horodatage lastMessageAt et un tableau de messages. Chaque objet de message au sein du tableau doit inclure un id, un role (soit user ou agent), un content et un horodatage createdAt.

Voici un exemple du format JSON attendu :

{
  "conversations": [
    {
      "id": "conv_12345",
      "url": "https://support.mycompany.com/conversations/12345",
      "lastMessageAt": "2023-10-27T14:30:00Z",
      "messages": [
        {
          "id": "msg_67890",
          "role": "user",
          "content": "Hello, I'm having trouble with...",
          "createdAt": "2023-10-27T14:25:00Z"
        },
        {
          "id": "msg_67891",
          "role": "support_agent",
          "content": "Hi there, I can help with that. Could you please provide...",
          "createdAt": "2023-10-27T14:30:00Z"
        }
      ]
    }
  ]
}

Dépannage

• Format JSON incorrect : assurez-vous que la réponse JSON de votre point de terminaison correspond au format spécifié dans cet article.

• URL invalide : assurez-vous que l'URL que vous fournissez est un point de terminaison accessible publiquement.

• Authentification : cette fonctionnalité ne prend pas actuellement en charge les points de terminaison authentifiés.