Los webhooks permiten enviar datos de tickets a otro sistema automáticamente cuando se cumplen condiciones específicas. Este enfoque es, a menudo, más simple que una configuración de API bidireccional, ya que el sistema receptor no necesita iniciar una solicitud API para obtener los datos del Atención de Soporte.

Si eres nuevo en los disparadores, te recomendamos encarecidamente revisar primero el artículo Disparadores. Estos recursos explican conceptos esenciales, terminología y cómo configurar las condiciones de los disparadores, conocimientos cruciales para configurar eficazmente disparadores de webhook.

Glosario

REST API: Un marco estandarizado que permite la comunicación entre diferentes sistemas a través de la web.
POST Method: Una solicitud REST API utilizada para enviar datos a un servidor.
Data Packet: Una unidad estructurada de datos formateada para su transmisión.
JSON: Un formato de archivo ampliamente utilizado para transmitir datos.

Configuración de un Webhook en el Atención de Soporte

Para crear un webhook:

1. Ve a Configuraciones > Automatización > Disparadores > Webhooks y crea un disparador del tipo Ticket.

2. Configura las condiciones del disparador para que coincidan con los escenarios donde el webhook debe ejecutarse.

3. Selecciona la acción Trigger Webhook e ingresa la URL donde se enviará la solicitud POST. La solicitud incluirá un paquete de datos JSON que contiene información del ticket.
   💡Tip: Puedes añadir acciones adicionales al disparador del webhook, como crear una nota para registrar que la información del ticket fue enviada a otro sistema. Todas las acciones configuradas se ejecutarán cuando se dispare el disparador.

4. Asegúrate de que el sistema receptor esté configurado para aceptar y procesar la solicitud POST del Atención de Soporte.

Paquete de Datos JSON

Cuando se dispara un disparador de webhook, este envía una solicitud POST a la URL especificada. La solicitud contiene un paquete de datos JSON con detalles sobre el ticket. Aquí tienes un desglose de la estructura de los datos:

Campos Principales

---

Estructura JSON de Ejemplo

{
  "Id": int,
  "Subject": string,
  "Status": string,
  "Justification": string,
  "Actions": [
    {
      "Id": int,
      "Description": string,
      "HtmlDescription": string,
      "Attachments": [
        {
          "FileName": string,
          "Path": string,
          "CreatedBy": {
            "Id": string,
            "PersonType": int,
            "ProfileType": int,
            "BusinessName": string,
            "Email": string,
            "Phone": string
          },
          "CreatedDate": string
        }
      ]
    }
  ],
  "WebhookEvents": [
    {
      "Criteria": int,
      "Operator": int
    }
  ],
  "Urgency": string,
  "ServiceFirstLevel": string,
  "CustomFieldValues": [
    {
      "CustomFieldId": int,
      "CustomFieldRuleId": int,
      "Line": int,
      "Value": string,
      "Items": [
        {
          "PersonId": string,
          "ClientId": string,
          "Team": string,
          "CustomFieldItem": string,
          "StorageFileGuid": string,
          "FileName": string
        }
      ]
    }
  ],
  "SlaSolutionTime": int
}

Comprendiendo el Registro de Ejecución del Webhook

Para monitorear los intentos de ejecución del webhook, ve a Configuraciones > Automatización > Disparadores > Webhooks > Webhook Execution Log. Este registro muestra todas las instancias en las que se disparó un disparador con la acción Trigger Webhook. Usa filtros como fecha, número de ticket y mensajes de error para refinar tu búsqueda.

El registro de ejecución es particularmente útil para probar o solucionar problemas con webhooks. Por ejemplo, muestra si el sistema receptor rechazó la solicitud POST y devolvió un error.