Closedloop Webhooks

Closedloop Webhooks permite a los administradores de Workspace configurar webhooks de salida que activan APIs externas basadas en eventos y condiciones relacionados con Tickets de Closedloop. Puedes seleccionar un evento de Ticket, agregar condiciones opcionales, configurar la solicitud de API, probar la configuración y activar el webhook.

También puedes incluir Objetos de Ticket y Campos de Ticket soportados en el cuerpo JSON de la solicitud y revisar los resultados de las ejecuciones de webhook a través de registros de ejecución.

Mira este video para aprender cómo funcionan los webhooks en Closedloop

Solo los administradores de Workspace pueden crear, editar, habilitar, deshabilitar y eliminar Webhooks. Los usuarios que no son administradores de Workspace no pueden gestionar configuraciones de webhook.

Navega a Experiencia del Cliente → Closedloop → Configuración del Workspace → Webhooks.

1. Navega a Experiencia del Cliente → Closedloop → Configuración del Workspace → Webhooks.
2. Haz clic en + Agregar Nuevo Webhook.

3. Ingresa una descripción del webhook. La descripción puede contener hasta 60 caracteres.
4. Configura el evento activador y cualquier condición requerida en el lógica de activación.
5. Haz clic en Siguiente.

6. Configura la solicitud de API en el solicitud de API.
7. Usa Ejecutar Prueba para probar la configuración de la API antes de guardar el webhook.
8. Revisa el resultado de la prueba y realiza cualquier cambio requerido.

9. Configura la asignación de datos para la respuesta de API y guarda el webhook. Los webhooks recién creados se habilitan automáticamente.

Puedes configurar un webhook para que se active cuando ocurra cualquiera de los siguientes eventos de Ticket de Closedloop:

• Ticket creado
• Ticket eliminado
• Ticket asignado
• Estado del Ticket cambiado
• Prioridad del Ticket cambiada
• Comentario del Ticket agregado
• Estado de inactividad del Ticket
• Incumplimiento del SLA de Acción
• Incumplimiento del SLA de Resolución

Puedes agregar condiciones basadas en Segmento Actual, Encuesta, y Variable Personalizada.

1. En el paso de lógica de activación, selecciona un tipo de condición.
2. Selecciona el valor requerido de las opciones disponibles en el menú desplegable.
3. Para Variable Personalizada, selecciona el nombre de la variable y su valor.

El operador de condición soportado es Es. Cuando se configuran múltiples condiciones, todas las condiciones deben coincidir para que se ejecute el webhook.

Si no se configuran condiciones, el webhook es elegible para ejecutarse cada vez que ocurra su evento de activación configurado.

Un webhook habilitado se ejecuta cuando ocurre el evento de Ticket configurado y todas las condiciones configuradas coinciden.

Si una condición configurada no coincide, el webhook no se ejecuta. Los webhooks deshabilitados no se ejecutan cuando ocurre su evento configurado.

1. En el paso de solicitud de API, ingresa la URL de la API. La URL de la API es obligatoria.
2. GET, POST, y PUT son los métodos de API soportados actualmente.
3. Selecciona el método de autenticación requerido.
4. Configura los encabezados de solicitud según sea necesario.
5. Para solicitudes POST y PUT, configura el cuerpo de la solicitud utilizando JSON válido si es necesario.
6. Revisa la configuración y usa Ejecutar Prueba para validar la solicitud.

Para solicitudes GET, el cuerpo de la solicitud está deshabilitado.

Los Webhooks de Closedloop soportan los siguientes métodos de autenticación:

• Sin Autenticación: No se requieren detalles de autenticación.
• Clave de API: Ingresa la Clave y el Valor, y selecciona si la clave de API debe añadirse al Encabezado de la solicitud o al Parámetro de Consulta.
• Token Bearer: Ingresa el Token.
• Autenticación Básica: Ingresa el Nombre de Usuario y la Contraseña.

Sí. Puedes configurar encabezados de solicitud como pares clave/valor al configurar la solicitud de API.

Los cuerpos de solicitud están disponibles para solicitudes POST y PUT. El cuerpo de la solicitud es opcional y debe contener JSON válido.

Puedes insertar Objetos de Ticket y Campos de Ticket soportados en el cuerpo de la solicitud desde la interfaz de configuración.

Puedes insertar los siguientes Objetos de Ticket soportados:

• {{ticket.details}}
• {{ticket.conversationHistory}}
• {{ticket.commentsHistory}}
• {{ticket.activityHistory}}
• {{ticket.rootCauseActions}}
• {{ticket.responseDetails}}

Puedes insertar los siguientes Campos de Ticket soportados:

• {{ticket.id}}
• {{ticket.status}}
• {{ticket.priority}}
• {{ticket.createdDate}}
• {{ticket.assignee}}
• {{ticket.currentSegment}}
• {{ticket.firstActionSla}}
• {{ticket.resolutionSla}}
• {{ticket.description}}

1. Completa la configuración de la solicitud de API.
2. Haz clic en Ejecutar Prueba.
3. Closedloop ejecuta la solicitud de API configurada utilizando la autorización, los encabezados de solicitud y el cuerpo de solicitud configurados.
4. Revisa el resultado de la prueba mostrado en el modal emergente.
5. Revisa la URL de la API y la respuesta o resultado devuelto.

Si la prueba falla, el modal emergente muestra un mensaje o razón apropiada para la falla.

La respuesta completa de la API se almacena en el sistema Campo de respuesta de webhook. La respuesta no se almacena directamente en el Ticket de Closedloop.

1. Navega a Experiencia del Cliente → Closedloop → Configuración del Workspace → Webhooks.
2. Haz clic en el nombre del webhook que deseas revisar.
3. Haz clic en Registros junto a Configuración.

Cada ejecución del webhook se registra en los registros de ejecución.

Los registros de ejecución incluyen:

• ID del webhook
• Sello de tiempo
• ID del Ticket
• Respuesta
• Status HTTP

Las respuestas de API fallidas también se registran en los registros de ejecución.

Haz clic en el ID de ejecución en los registros de ejecución del webhook para abrir la información detallada de ejecución en un modal.

El modal de detalles incluye la URL de la solicitud, Carga útil y respuesta de API.

1. Navega a Experiencia del Cliente → Closedloop → Configuración del Workspace → Webhooks.
2. Ubica el webhook que deseas modificar.
3. Usa el control de Editar para el webhook.
4. Actualiza la configuración requerida.
5. Guarda los cambios.

Los administradores de Workspace pueden editar webhooks existentes.

Los administradores de Workspace pueden habilitar o deshabilitar webhooks existentes desde la página de configuración de Webhooks.

Cuando un webhook está deshabilitado, no se ejecuta cuando ocurre su evento de Ticket configurado.

1. Navega a Experiencia del Cliente → Closedloop → Configuración del Workspace → Webhooks.
2. Ubica el webhook que deseas eliminar.
3. Haz clic en el control de Eliminar para el webhook.
4. Confirma la eliminación.

Las solicitudes de API fallidas se registran en los registros de ejecución del webhook. Las solicitudes de API fallidas no se reintentan automáticamente y no activan una acción adicional de Ticket de Closedloop.

• Configura integraciones entre Closedloop y sistemas externos sin una configuración de integración separada para cada flujo de trabajo.
• Controla qué eventos de Ticket activan APIs externas.
• Usa condiciones para asegurar que solo los eventos relevantes de Ticket invoquen una API externa.
• Configura autenticación y encabezados de solicitud para solicitudes de API externas.
• Construye cuerpos de solicitud JSON utilizando Objetos de Ticket y Campos de Ticket soportados.
• Prueba configuraciones de API antes de activar un webhook.
• Revisa los resultados de ejecución de webhook a través de registros de ejecución estandarizados.

• Usa una descripción clara del webhook para que el propósito de la configuración sea fácil de identificar.
• Configura condiciones cuando la API externa solo deba ser activada para criterios específicos de Ticket.
• Revisa la URL de la API, autenticación, encabezados y cuerpo de solicitud antes de guardar el webhook.
• Usa Ejecutar Prueba para validar la configuración de la API antes de depender de eventos de Ticket en vivo.
• Revisa los registros de ejecución para monitorear solicitudes de webhook y respuestas de API.