Ferndesk
Integraciones

Endpoint personalizado de soporte

Conecta un endpoint personalizado de soporte a Ferndesk para integrar tu propio sistema de tickets o soporte, incluso si no es compatible de forma nativa con Ferndesk.

Requisitos previos

  • Debes tener una URL de acceso público que devuelva una respuesta JSON.

  • Debes tener permisos para administrar integraciones en Ferndesk.

Conectar un endpoint personalizado

  1. Ve a la página de Integraciones en la configuración de Ferndesk.

    Página de Integraciones que muestra la cuadrícula de tarjetas de integración disponibles

  2. Haz clic en Conectar primera herramienta o busca la tarjeta de Endpoint personalizado de soporte.

  3. Haz clic en Conectar en la tarjeta de Endpoint personalizado de soporte.

  4. En el cuadro de diálogo de configuración, introduce la URL de tu endpoint personalizado de soporte en el campo Source URL.

  5. Haz clic en Guardar 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 personalizado de soporte incluidas en los resultados de la auditoría.

Formato JSON

El endpoint personalizado de soporte 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 support_agent), 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 de acceso público.

  • Autenticación: Esta función actualmente no admite endpoints autenticados.

Para mejorar la confiabilidad de tu endpoint personalizado de soporte, recomendamos lo siguiente:

  • Implementa un botón de "Prueba" 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.

Qué sucede después de conectar

Las tendencias de soporte de tu endpoint personalizado aparecen en Reporting en Intelligence. Para recibir automáticamente recomendaciones sobre lagunas en la documentación, activa las auditorías programadas en Configuración > Automatizaciones.

¿Te fue útil?
¿Te fue útil?