Endpoint de soporte personalizado
Descripción general
Este artículo explica cómo conectar un endpoint de soporte personalizado a Ferndesk. Esta función te permite integrar tu propio sistema de tickets o soporte, incluso si Ferndesk no lo admite de forma nativa.
Requisitos previos
Debes tener una URL accesible públicamente que devuelva una respuesta JSON.
Debes contar con permisos para administrar integraciones en Ferndesk.
Pasos
Ve a la página de Integraciones en la configuración de Ferndesk.
Haz clic en el botón "Add Integration". Esto te llevará a la página de Connect an integration.
Selecciona "Support Endpoint" de la lista de integraciones disponibles.
En el cuadro de diálogo de configuración, verás un campo etiquetado como "Source URL".
Introduce la URL de tu endpoint de soporte personalizado. El texto de marcador de posición para este campo es
https://company.com/support-endpoint.json?startDate=2025-01-01.Haz clic en el botón "Save" para conectar el endpoint.
Una vez conectado, Ferndesk comenzará a importar conversaciones desde tu endpoint para identificar lagunas en la documentación y sugerir actualizaciones.
Verificar la configuración
Una vez conectado, puedes verificar que funciona correctamente creando una auditoría. Si la conexión es correcta, deberías ver conversaciones de tu sistema de soporte personalizado incluidas en la auditoría.
Formato JSON
El endpoint de soporte personalizado debe devolver una respuesta JSON con un formato específico. El objeto raíz debe contener una clave conversations, que almacena un array de objetos de conversación. Cada objeto de conversación debe tener un id, una marca de tiempo lastMessageAt y un array de messages. Cada objeto de mensaje dentro del array debe incluir un id, role (ya sea user o c), content y una marca de tiempo createdAt.
Aquí tienes un ejemplo del formato JSON esperado:
{
"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"
}
]
}
]
}Si el formato JSON es incorrecto, los datos no se ingerirán. Además, esta función actualmente no admite endpoints autenticados.
Solución de problemas
Formato JSON incorrecto: Asegúrate de que la respuesta JSON de tu endpoint coincida con el formato especificado en este artículo.
URL no válida: Asegúrate de que la URL que proporcionas sea un endpoint accesible públicamente.
Autenticación: Esta función actualmente no admite endpoints autenticados.
Para mejorar la fiabilidad de tu endpoint de soporte personalizado, te recomendamos lo siguiente:
Implementa un botón "Test" en tu sistema para verificar que el endpoint sea accesible y que la respuesta JSON sea válida antes de guardar la integración.
Implementa mensajes de error más descriptivos para ayudarte a solucionar problemas con tu endpoint, como una URL inaccesible, una respuesta JSON no válida o fallos de autenticación.