Benutzerdefinierter Support-Endpunkt
Verbinden Sie einen benutzerdefinierten Support-Endpunkt mit Ferndesk, um Ihr eigenes Ticket- oder Support-System zu integrieren, auch wenn es von Ferndesk nicht nativ unterstützt wird.
Voraussetzungen
Sie müssen über eine öffentlich erreichbare URL verfügen, die eine JSON-Antwort zurückgibt.
Sie müssen über Berechtigungen verfügen, um Integrationen in Ferndesk zu verwalten.
Benutzerdefinierten Endpunkt verbinden
Gehen Sie in Ihren Ferndesk-Einstellungen zur Seite Integrationen.
Klicken Sie auf Erstes Tool verbinden oder navigieren Sie zur Karte Benutzerdefinierter Support-Endpunkt.
Klicken Sie auf der Karte Benutzerdefinierter Support-Endpunkt auf Verbinden.
Geben Sie im Konfigurationsdialog die URL Ihres benutzerdefinierten Support-Endpunkts im Feld Source URL ein.
Klicken Sie auf Speichern, um den Endpunkt zu verbinden.
Nach der Verbindung beginnt Ferndesk damit, Konversationen von Ihrem Endpunkt zu importieren, um Lücken in der Dokumentation zu erkennen und Aktualisierungen vorzuschlagen.
Einrichtung überprüfen
Sobald die Verbindung hergestellt ist, können Sie überprüfen, ob alles korrekt funktioniert, indem Sie ein Audit erstellen. Wenn die Verbindung erfolgreich war, sollten Sie in den Audit-Ergebnissen Konversationen aus Ihrem benutzerdefinierten Support-System sehen.
JSON-Format
Der benutzerdefinierte Support-Endpunkt muss eine JSON-Antwort in einem bestimmten Format zurückgeben. Das Root-Objekt sollte einen conversations-Schlüssel enthalten, der ein Array von Konversationsobjekten enthält. Jedes Konversationsobjekt muss eine id, einen Zeitstempel lastMessageAt und ein Array von messages haben. Jedes Nachrichtenobjekt innerhalb des Arrays sollte eine id, 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 falsch ist, werden die Daten nicht importiert. 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 von Ihnen angegebene URL ein öffentlich erreichbarer 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 fehlgeschlagene Authentifizierung.
Was nach der Verbindung passiert
Support-Trends aus Ihrem benutzerdefinierten Endpunkt werden unter Reporting im Bereich Intelligence angezeigt. Um automatisch Empfehlungen zu Dokumentationslücken zu erhalten, aktivieren Sie geplante Audits in Einstellungen > Automatisierungen.