Ferndesk
Integrationen

Benutzerdefinierter Support-Endpunkt

Verbinden Sie einen benutzerdefinierten Support-Endpunkt mit Ferndesk, um Ihr eigenes Ticket- oder Supportsystem zu integrieren, auch wenn es von Ferndesk nicht nativ unterstützt wird.

Voraussetzungen

  • Sie müssen über eine öffentlich zugängliche URL verfügen, die eine JSON-Antwort zurückgibt.

  • Sie müssen über die erforderlichen Berechtigungen verfügen, um Integrationen in Ferndesk zu verwalten.

Benutzerdefinierten Endpunkt verbinden

  1. Gehen Sie in Ihren Ferndesk-Einstellungen zur Seite Integrationen.

    Integrationsseite mit der Karte „Support-Endpunkt“

  2. Klicken Sie auf Erstes Tool verbinden oder navigieren Sie zur Karte „Support-Endpunkt“.

  3. Klicken Sie auf der Karte „Support-Endpunkt“ auf Verbinden.

  4. Geben Sie im Konfigurationsdialog die URL Ihres benutzerdefinierten Support-Endpunkts in das Feld Quell-URL ein.

  5. Klicken Sie auf Verbinden, um den Endpunkt zu verbinden.

    Konfigurationsdialog mit dem Feld „Quell-URL“ und der Aktion „Verbinden“

Sobald die Verbindung hergestellt ist, beginnt Ferndesk, Unterhaltungen von Ihrem Endpunkt zu importieren, um Dokumentationslücken zu identifizieren und Aktualisierungen vorzuschlagen.

Einrichtung überprüfen

Sobald die Verbindung hergestellt ist, können Sie durch Erstellen eines Audits überprüfen, ob sie ordnungsgemäß funktioniert. Bei erfolgreicher Verbindung sollten in den Auditergebnissen Unterhaltungen aus Ihrem benutzerdefinierten Supportsystem angezeigt werden.

JSON-Format

Der benutzerdefinierte Support-Endpunkt muss eine JSON-Antwort in einem bestimmten Format zurückgeben. Das Stammobjekt sollte einen Schlüssel conversations enthalten, der ein Array von Konversationsobjekten enthält. Jedes Konversationsobjekt muss über eine id, einen Zeitstempel lastMessageAt und ein Array mit messages verfügen. Jedes Nachrichtenobjekt innerhalb des Arrays sollte eine id, eine role (entweder user oder support_agent), content und einen Zeitstempel createdAt enthalten.

Hier ist ein Beispiel für das erwartete JSON-Format:

{
  "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"
        }
      ]
    }
  ]
}

Wenn das JSON-Format nicht korrekt ist, werden die Daten nicht eingelesen. Außerdem unterstützt diese Funktion derzeit keine authentifizierten Endpunkte.

Fehlerbehebung

  • Falsches JSON-Format: Stellen Sie sicher, dass die JSON-Antwort Ihres Endpunkts dem in diesem Artikel angegebenen Format entspricht.

  • Ungültige URL: Stellen Sie sicher, dass die angegebene URL ein öffentlich zugänglicher Endpunkt ist.

  • Authentifizierung: Diese Funktion unterstützt derzeit keine authentifizierten Endpunkte.

Um die Zuverlässigkeit Ihres benutzerdefinierten Support-Endpunkts zu verbessern, empfehlen wir Folgendes:

  • Implementieren Sie in Ihrem System eine Schaltfläche „Test“, um vor dem Speichern der Integration zu überprüfen, ob der Endpunkt erreichbar ist und die JSON-Antwort gültig ist.

  • Implementieren Sie aussagekräftigere Fehlermeldungen, damit Sie Probleme mit Ihrem Endpunkt leichter beheben können, z. B. eine nicht erreichbare URL, eine ungültige JSON-Antwort oder Authentifizierungsfehler.

Was nach dem Verbinden geschieht

Support-Trends von Ihrem benutzerdefinierten Endpunkt werden in Berichte unter Intelligenz angezeigt. Um automatisch Empfehlungen zu Dokumentationslücken zu erhalten, aktivieren Sie geplante Audits unter Einstellungen > Automatisierungen.

War das hilfreich?
War das hilfreich?