Endpoint de soporte personalizado

Resumen

Este artículo explica cómo conectar un endpoint de soporte personalizado a Ferndesk. Esta función le permite integrar su propio sistema de tickets o soporte, incluso si no es compatible de forma nativa con Ferndesk.

Prerrequisitos

• Debe tener una URL accesible públicamente que devuelva una respuesta JSON.

• Debe tener permisos para gestionar integraciones en Ferndesk.

Pasos

1. Navegue a la página de Integraciones en sus ajustes de Ferndesk.

2. Haga clic en el botón "Añadir integración". Esto le llevará a la página Conectar una integración.

3. Seleccione "Support Endpoint" de la lista de integraciones disponibles.

4. En el diálogo de configuración, verá un campo etiquetado como "Source URL".

5. Introduzca la URL de su 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.

6. Haga clic en el botón "Guardar" para conectar el endpoint.

Verificar la configuración

Una vez que haya conectado su endpoint de soporte personalizado, puede verificar que está funcionando correctamente creando una auditoría. Si la conexión es exitosa, debería ver las conversaciones de su 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 contiene 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 agent), content y una marca de tiempo createdAt.

Este es 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"
        }
      ]
    }
  ]
}

Resolución de problemas

• Formato JSON incorrecto: Asegúrese de que la respuesta JSON de su endpoint coincida con el formato especificado en este artículo.

• URL no válida: Asegúrese de que la URL que proporcione sea un endpoint accesible públicamente.

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