Evento JSON

Acerca del evento JSON

¿Alguna vez ha querido que se hiciera una solicitud en su sitio web para activar un ticket en Qualtrics? ¿Alguna vez ha querido crear una integración fluida entre Qualtrics y su propio sistema interno? ¿Alguna vez ha querido desencadenar una tarea en la pestaña Flujos de trabajo, pero con un evento que ocurre fuera de Qualtrics?

Los eventos JSON permiten que el software externo inicie workflows mediante una solicitud HTTP. En lugar de esperar a que un evento en Qualtrics desencadene más acciones en la plataforma, simplemente puede configurar un evento JSON para recibir solicitudes de un tercero.

Limitaciones

El evento JSON no es compatible con las siguientes configuraciones:

• Cualquier cosa que no sea HTTP (por ejemplo, cola de mensajes, SMS).
• Llamadas HTTP de salida.
• Procesar XML (el cuerpo de la solicitud XML se ignorará).
• Procese cualquier cosa que no sea JSON.
• Autenticar de cualquier forma que no sea una cabecera X-API-TOKEN o nuestra autorización HTTP básica modificada.
  Consejo Q: OAuth y otras formas de autenticación no son compatibles con los eventos JSON.
• Cualquier análisis sintáctico JSON que no pueda satisfacerse utilizando consultas JSONPath en el cuerpo JSON.
• Llamadas que exceden el límite de tasa API de 3.000 por minuto.
• Payloads superiores a 100 KB.

Tipos de autorización admitidos

Autenticación basada en token/Autenticación de cabecera

Puede autenticarse pasando su token de API por la cabecera de la solicitud como X-API-TOKEN.

body.curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{

     SurveyId': "SV_012345678912345",

     "format": "csv"

 }" 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'

Autorización básica HTTP

Basic Auth suele ser una versión codificada Base64 de username:password. Sin embargo, para mejorar la seguridad, Qualtrics utiliza una cadena codificada Base64 de nombre de usuario:x-api-token.

Para utilizar la Autorización básica, debe fijar cabeceras en la solicitud HTTP. La cabecera específica es Autorización.

 demo@qualtrics.com:f8gIK7G6GFH985Y4

 Básica ZGVtb0BxdWFsdHJpY3MuY29tOmY4Z0lLN0c2R0ZIOTg1WTQ=

Configuración de un evento JSON

1. Primero, tendrá que crear un workflow. Vaya al Pestaña Flujos de trabajo en un proyectoo la página Flujos de trabajo independientes.
   
2. Asegúrese de que se encuentra en la pestaña Sus workflows.
3. Haga clic en Crear un flujo de trabajo.
4. Seleccione Iniciado cuando se recibe un evento.
5. Seleccione el evento JSON.
   
6. Si lo desea, especifique un Desencadenador de resumen, que debería describir el objetivo del evento JSON.
7. Se le proporcionará una URL. Utilícelo para invocar su nuevo flujo de trabajo desde fuera de Qualtrics, utilizando Postman, su propio sistema interno u otras aplicaciones similares. Para copiarla, haga clic en Copiar URL.
8. Ahora puede definir los datos del evento. Esto capturará datos de la solicitud de entrada. Para empezar, haga clic en Configuración avanzada.
   Consejo Q: Para obtener información sobre la sección Prueba, consulte Captura de eventos a continuación.
9. En el cuadro de la izquierda, indique el nombre del campo JSON. En la casilla de la derecha, indique la ubicación dentro de los datos del evento (cuerpo de la solicitud HTTP).
   
   Consejo Q: Las ubicaciones deben tener el formato JSONPath. Consulte la siguiente tabla para obtener una guía rápida sobre la sintaxis JSONPath.
10. Para añadir otro campo, haga clic en Añadir un campo JSON.
11. Si desea agregar un parámetro GET, agréguelos en la sección Parámetros GET. Para obtener más información sobre cuáles son estos parámetros y cómo funcionan en API, consulte nuestra documentación de API sobre Parámetros.
    Advertencia: No es aconsejable transferir datos de identificación personal mediante parámetros GET. Cualquier información personal identificable o datos confidenciales deben transmitirse a través del cuerpo POST siempre que sea posible, ya que POST es más seguro. Póngase en contacto con el soporte técnico de Qualtrics si tiene dudas o preguntas.
12. Para eliminar un campo, haga clic en el signo menos ( – ).
13. Para guardar los cambios, haga clic en Guardar.
14. Ahora puede añadir condiciones y una tarea a su flujo de trabajo haciendo clic en el signo más ( + ). Las condiciones determinan cuándo se ejecuta un workflow, mientras que las tareas son el resultado del workflow. Consulte la Resumen de workflows para obtener más información.
    

Captura de eventos

Al crear un evento API externo, es posible que deba analizar sintácticamente los datos del cuerpo de la publicación. Sin embargo, puede ser difícil a veces analizar estos datos. Si desea averiguar qué está enviando su API externa, siga estos pasos.

1. Haga clic en su evento JSON.
   
2. Por defecto, los campos JSON de captura de los resultados de test para que se puedan utilizar como texto dinámico en otras tareas de esta opción de workflow se activarán. Esta opción hace que los campos analizados en el cuerpo del payload estén disponibles automáticamente como texto dinámico cuando añada sus tareas de workflow.
   
3. Haga clic en Ejecutar una nueva prueba.
4. Verá un mensaje de que Qualtrics está esperando recibir el evento de su sistema externo. Desactive su API externa.
   Consejo Q: Para cancelar esta prueba, haga clic en Cancelar prueba.
5. Si la prueba se ha realizado correctamente, verá el mensaje Conectado correctamente al servidor. El payload se analizará sintácticamente y se añadirá a la ventana.
6. Si lo desea, haga clic en Ejecutar una nueva prueba para ejecutar otra prueba. Deberá ejecutar su siguiente llamada a la API después de hacer clic en esta opción.
7. Haga clic en Guardar.

Sintaxis JSONPath

La siguiente tabla proporciona algunos de los conceptos básicos de la sintaxis JSONPath. Tenga en cuenta que Qualtrics no los establece, pero son estándares que se utilizan con JSON.

Ejemplo de sintaxis JSONPath

En este ejemplo, le mostraremos cómo, dado un objeto JSON, se puede utilizar la tabla JSONPath.

Este es nuestro objeto JSON:

{
 "eventDescription": "Monthly Revenue",
 "stores": [
 {
 "name": "Acme Store",
 "total": 1000000,
 "topItem":

 { "price": "top Item": "]
" }
,
 { "name" {
 "name": "banana Stand", "total": 250000, "topItem": { "price": "4", "total" "STand", "total" "plan}

":

 "topItem": { "price": "4", "total" "Stand", "total": 250000, "topItem": { "price": "4", "total" "Stand", "total": "250000, "topItem": { "price": "4", "total" "Stand", "total", "250000", "topItem": { "price": "4" Item,
 "total" "P}", "total Stand",
 "total": 250000,
 "topItem":

 { "price": "4", "total", "Piz}", "total", "Piz}
", "Piz}", "Pizol", "Piz}", "
F3", "Pizol",

 "Pizol", "Tot."

Ahora, debemos agregar los valores de retorno que vemos en la tabla JSONPath para dejarlo más claro.

$ -> Acme Store
 @ -> [
 {
 "name": "Acme Store",
 "total": 1000000,
 "topItem":

 { "price": "50", "description": "Anvil" }
 }

 . -> Ingresos mensuales
 .. -> 50

 -> ["Acme Store",
 "The Banana Stand", "Pizza

 Planet"]
 [] -> Acme Store



 [,] -> [
 Unknown macro: { "
name"}
:

 Unknown macro: 

 "name" 
}



*name: [1"Change start": 1$:start: 






"name"() -> [{
 "name": "Acme Store",
 "total": 1000000,
 "topItem":

 { "price": "50", "description": "Anvil" }
 }]

 () -> [
 {
 "name": "Pizza Planet",
 "total": 80000,
 "Item": "peroni" "15" "name": "Pizza Planet",
 "total": 80000,
 top"Item": "peroni": 

API de ejemplo en Javascript de nodo

El siguiente ejemplo es una plantilla básica que puede seguir al dar formato a sus Datos de evento.

var request = need('request-promise');
 var SurveyId = "SV_XXXXXXXXXXXX";
 var trigger Id = "OC_XXXXXXXXXXX";
 var brandId = "YOUR_BRAND_ID";
 var userId = "UR_XXS_XXXXXXXXX";event acdatacenter = "xx1";

 tricalapiken = "TO_XXS_XXXXXXX";event vardatacenter = "xx1";tricalapiken = TO_XXS_XXXXXXX" + var datacenter = "xx1";tricalapiken = TOals.com = ¿TO_XXXXXXXXXXX" + var datacenter = "xx1";tricalapiken = TOalapiken = TO_XXS_XXXXXXX" + var datacenter = "xx1";tricalapiken = TO_XXS_XXXXXXX" + var datacenter = "xx1";tricalapiken "tricalken = TO_XXS_XXXXXXX" = var datacenter = "xx1";tricalapiken "tricalken = TO_XXS_XXXXXXX" = var datacenter = "xx1";tricalapiken = TOals.com = TO_XXS_XXXXXXX" = var datacenter = "xx1";var Toalapiken = TO_XXS_XXXXXXXXX" + var datacenter = "xx1";tricalapiken = TOals.com =¿TO_XXXXXXXXX" + 
      var datacenter = "xx1";tricalapiken = TOals.com = TO_XXXXXXXXX" = var datacenter = "xx1";tricalapiken "tricalken" = "TO_XXS_XXXXXXXXX" = var datacenter = "xx1";tricalapiken "tricalken" = "TO_XXS_XXXXXXX" = 
 var datacenter = "xx1";
 tricalapiken "tricals.com = TO_XXS_XXXXXXX" = var datacenter = "xx1"contextId=" + SurveyId + "&userId=" + userId + "&brandId=" + brandId + "&launerId=" + trigger erId;
 var payload = {
     "text": "This is some text",
     "object": {
         "ent-number" 
         },
 "text": RED/

son!: ["son": 
    
    
    
    
     },
     "text": RED/son!: ["a"
        "X-API-TOKEN": apiToken
     }
 };

 request.post(options).then(function (ret) {
     console.log("success:", url, payload);
 }).catch(function (err) {
     console.log("error: ", url);
     console.log(err);
 });

Ejemplo: Integración con Freshdesk

El evento JSON se puede utilizar para la integración con Freshdesk como regla de Webhook en Dispatch’r. Esto significa que los eventos en Freshdesk pueden desencadenar tareas en Qualtrics, como la creación de un ticket o la distribución de una encuesta.

1. En Qualtrics, defina su evento como Evento JSON.
   
2. Copie la URL.
   
3. En una nueva pestaña, inicie sesión en Freshdesk.
4. En la sección Administración, vaya a la opción que mejor se ajuste al tipo de regla que desee establecer.
   
   Consejo Q: Conozca la diferencia entre Dispatch’r, Supervisor y Observador en la documentación de soporte de Freshdesk.
5. Cree una regla nueva.
   
6. Establezca condiciones para determinar qué evento de Freshdesk debe desencadenar una tarea en Qualtrics.
   
   Ejemplo: Puede que cuando un agente de Freshdesk haga que el estado del ticket cambie de cualquier estado a Resuelto, le gustaría enviar una encuesta de CSAT utilizando Qualtrics.
7. Añada una nueva acción y seleccione Desencadenar enlace web.
   
8. Fije el Tipo de solicitud en POST.
   
9. En URL de llamada de retorno, pegue la URL de evento JSON del paso 2.
10. Para utilizar la autenticación de token, añada cabeceras personalizadas, introduzca X-API-TOKEN: y fíjelo igual a su token de API.
    
11. Para utilizar la autenticación HTTP Basic, haga clic en Requiere autenticación, añada su nombre de usuario de Qualtrics y, en lugar de su contraseña, introduzca su token de API.
    
12. Asegúrese de que la codificación es JSON.
    
13. Seleccione manualmente el contenido que desea transferir o seleccione Avanzado para introducir un cuerpo JSON.
14. Guarde la regla.
15. En Qualtrics, finalice su flujo de trabajo. En este ejemplo, probablemente añadiríamos un Tarea de XM Directory.
    
16. No olvide publicar los cambios de la encuesta cuando esté listo para su inicio.

Ejemplo: Integración con ServiceNow

El evento JSON se puede utilizar para la integración con ServiceNow. Esto significa que los eventos en ServiceNow pueden desencadenar tareas en Qualtrics, como la creación de un ticket o la distribución de una encuesta.

1. En Qualtrics, defina su evento como Evento JSON.
   
2. Copie la URL.
   
3. En una nueva ficha, inicie sesión en su instancia de desarrollador de ServiceNow.
4. Seleccione Mensaje REST.
   
5. Haga clic en Nuevo.
6. Denomine su mensaje de descanso.
   
7. En el campo Punto final, pegue la URL que ha copiado en el paso 2.
8. Cambie el tipo de autenticación a Básico.
9. Vaya a la pestaña Solicitud HTTP.
   
10. Haga doble clic para añadir X-API-TOKEN.
11. Haga doble clic para pegar su token de API.
    
12. En una fila nueva, añada el nombre Tipo de contenido.
13. Establezca el valor en application/json.
14. Haga clic en Enviar.
    
15. Vuelva a abrir el mensaje del resto.
    
16. En Métodos HTTP, haga clic en Nuevo.
    
17. Asigne un nombre al método.
    
18. Fije el método HTTP en POST.
19. Establezca el tipo de autenticación en Heredar del primario.
20. Haga clic en Enviar.
21. Vuelva a abrir el método HTTP POST que acaba de crear.
    
22. En la parte inferior de la página, seleccione Vista previa del uso de script.
    
23. Copie el texto.
24. Busque y seleccione Reglas empresariales.
    
25. Seleccione Nuevo.
26. Seleccione una tabla.
    
27. Seleccione Avanzado.
28. Determine cuándo se ejecuta la regla empresarial.
    Ejemplo: Si ha seleccionado Incidente para su tabla y desea enviar una encuesta CSAT para tickets resueltos, podría añadir una condición que establezca que esta regla se debe ejecutar cuando el estado del Incidente cambie a Resuelto.
    Consejo Q: El soporte técnico de Qualtrics puede ayudarle a configurar su evento JSON y conectarlo a través de ServiceNow. Sin embargo, puede haber algunas preguntas sobre la funcionalidad ServiceNow que no pueden responder. Si tiene preguntas sobre cómo y cuándo se ejecutan las reglas de negocio, consulte la documentación de ServiceNow sobre cómo funcionan las reglas de negocio.
29. Vaya a la pestaña Avanzado.
    
30. Pegue el contenido que ha copiado del paso 22, donde dice Agregar su código aquí.
    
31. Añada un cuerpo. Aquí puede comunicar la información que desea transmitir a Qualtrics.
    

    Ejemplo: Este es un ejemplo del código final que incluiría en este campo. La mayor parte de este código es el mensaje de salida proporcionado por ServiceNow y variará de un ejemplo a otro. Lamentablemente, el soporte técnico de Qualtrics no puede ayudarle con ninguna codificación personalizada; si tiene problemas con su código, póngase en contacto con la comunidad de ServiceNow para obtener ayuda.

    La parte en negrita del código incluye tres funciones adicionales no incluidas en el código original: un cuerpo JSON que extrae el ID de usuario y el estado del incidente, y una llamada que recupera la dirección de correo electrónico del cliente del incidente para que se le pueda enviar el CSAT (en cursiva a continuación). Consulte la documentación de ServiceNow y consulte a su comunidad si tiene preguntas adicionales.

    (función executeRule(actual, anterior /*nulo al async*/) {
    
         // Añada su código aquí
        
      pruebe { 
         var r = new sn_ws.RESTMessageV2('Qualtrics JSON Event ', 'JSON Event POST');
         var body = {
              "User ID": gs.getUserID()
              "state incidente": current.state.} getDisplayValue;()
         
         
         var target = nuevo GlideRecord('sys_user');
          target.addQuery('sys_id', '=', current.caller_id);
          target.query();
          while(target.next()) {
              body["email"] = target.email.getDisplayValue();
          }      
          var response = r.run();
          var responseBody = response.getBody();
          var httpStatus = response.getStatusCode();
          gs.addInfoMessage(httpStatus);
         }interceptar
    (ex) {
          var message = ex.message;
          gs.addInfoMessage("Error comunicating w Qualtrics " + message);
    
     }}
    
    )(actual, anterior);

32. Añada el cuerpo a la solicitud. Añada lo siguiente en la parte en negrita y en cursiva del código del paso anterior:

     r.setRequestBody(JSON.stringify(cuerpo)); 

33. Haga clic en Enviar.
34. En Qualtrics, finalice su flujo de trabajo. Para continuar con el ejemplo de la encuesta de CSAT, probablemente añadiríamos un Tarea de XM Directory.
    
35. No olvide publicar los cambios de la encuesta cuando esté listo para su inicio.

Ejemplo: Integración con Microsoft Dynamics a través de Microsoft Flow

El evento JSON hace que los eventos en Microsoft Dynamics puedan desencadenar tareas en Qualtrics, como la creación de un ticket o la distribución de una encuesta. Por ejemplo, cada vez que elimine un registro de cuenta en Microsoft, puede distribuir una encuesta de Qualtrics al propietario de la cuenta que formule preguntas de salida. (Por ejemplo, lamentamos que se vaya! ¿Cómo estuvo tu tiempo con nosotros? ¿Cómo podemos mejorar?)

Para integrar el evento JSON con acciones que se producen en Microsoft Dynamics, en realidad debe realizar la configuración dentro de Microsoft Flow en lugar de Dynamics. No se preocupe – Microsoft Flow se libera con todas las cuentas de Microsoft Dynamics, por lo que puede iniciar sesión en Flow con su información de Dynamics aquí.

1. En Qualtrics, defina su evento como Evento JSON.
   
2. Copie la URL.
   
3. En una pestaña separada, vaya a https://us.flow.microsoft.com/en-us/ y utilice la información de Microsoft Dynamics para iniciar sesión en Flujo.
4. Seleccione Mis flujos a la izquierda.
   
5. Haga clic en Nuevo y seleccione Automatizado: en blanco.
6. Asigne un nombre al movimiento.
   
7. Seleccione un desencadenador. Este es el evento que ocurre en Microsoft que iniciará la tarea en Qualtrics. Puedes elegir lo que sirva para tus propósitos, pero para este ejemplo, elegiríamos “Cuando se elimine un registro (Dynamics 365)”.
8. Haga clic en Crear.
9. En Nombre de organización, inicie sesión en su cuenta de Dynamics.
   
10. En Nombre de entidad, seleccione el tipo de registro o archivo. Para nuestro ejemplo, utilizaríamos “Cuentas”.
11. Haga clic en Paso siguiente y seleccione Añadir una acción.
12. Seleccione HTTP.
    
13. Modifique el método a POST.
14. Pegue su URL de evento JSON en el campo URI.
15. Usar autenticación de token. En Cabeceras, introduzca X-API-TOKEN y, en el campo junto a él, pegue su token de API.
16. En Cuerpo, puede introducir un cuerpo JSON. Esto le ayudará a decidir la información que desea transferir de Dynamics a Qualtrics.
    Consejo Q: Utilice el botón Añadir contenido dinámico para seleccionar los campos de registro de Dynamics que desea transferir a Qualtrics. Asegúrese de seguir el formato JSON adecuado, como se muestra en la captura de pantalla. Para obtener ayuda sobre la resolución de problemas con el contenido dinámico, póngase en contacto con el soporte de Microsoft.
17. Cuando haya terminado, haga clic en Guardar.
18. En Qualtrics, finalice su flujo de trabajo. En este ejemplo, probablemente añadiríamos un Tarea de XM Directory.
    
19. No olvide publicar los cambios de la encuesta cuando esté listo para su inicio.

Ejemplo: Integración con Genesys PureCloud

Con los eventos JSON, puede integrar con Genesys PureCloud para enviar a los clientes una encuesta de seguimiento después de completar un teléfono de soporte o una interacción de chat.

1. En la encuesta que desea enviar, vaya a Flujos de trabajo.
   
2. Cree un nuevo workflow basado en eventos.
3. Para el evento de workflow, seleccione el evento JSON.
   
4. Haga clic en Copiar URL para copiar el punto final del evento en el portapapeles.
   
5. Sin cerrar la ventana Evento JSON, abra una nueva pestaña en su navegador y navegue a Genesys.
6. Vaya a Admin.
   
7. Haga clic en Acciones.
8. Haga clic en Añadir acción.
   
9. Seleccione Acciones de datos de servicios web como Nombre de integración.
   
   Consejo Q: Si no tiene la opción de seleccionar Acciones de datos de servicios web, debe activar la integración. Consulte esta página para obtener más información.
10. Asigne un nombre de acción a su acción.
11. Haga clic en Añadir.
12. Vaya a la ficha Configuración.
    
13. Vaya a la pestaña Contratos.
14. En Contrato de entrada, seleccione JSON.
15. Configure las propiedades que se envían a Qualtrics.

    Ejemplo: Por ejemplo, el siguiente código transferirá la dirección de correo electrónico, el número de teléfono, el nombre y los apellidos.

    {
            "type": "object",
            "properties": {
              "emailAddress": {
                "type": "string"
              },
              "phoneNumber": {
                "type": "string"
              },
              "firstName": {
                "type": "string"
              },
              "lastName": {
                "type": "string"
              }
           ,
            "additionalProperties": } true
         

16. Vaya a la pestaña Configuración.
17. Modifique el tipo de solicitud a POST.
18. En el campo Plantilla de URL de solicitud, pegue la URL del evento JSON en Qualtrics.
19. Haga clic en Añadir cabecera.
    
20. En la casilla Clave, introduzca X-API-TOKEN.
21. En el cuadro Valor, introduzca su token de API de Qualtrics.
22. Vaya a la pestaña Test.
23. Introduzca valores de prueba para sus propiedades.
24. Haga clic en Ejecutar acción.
25. Genesys le dirá si la acción fue exitosa. Si falla, se mostrará la respuesta de error para ayudarle a solucionar el problema.
    
26. Vuelva a su evento JSON en Qualtrics y verifique que sus propiedades se hayan transferido correctamente a Qualtrics.
27. Haga clic en Guardar.
28. Haga clic en el signo más ( + ) y, a continuación, en Tarea para configurar la tarea que desea seguir cuando se desencadene el evento JSON. En nuestro caso, queremos enviar una encuesta a los encuestados, así que seleccionamos la tarea XM Directory.
    Consejo Q: Al configurar su tarea, utilice el menú de texto dinámico para utilizar los valores transferidos desde Genesys (por ejemplo, correo electrónico del cliente, nombre, etc.).
29. Después de configurar la tarea en Qualtrics, vuelva a Genesys y haga clic en Guardar y publicar.
    
30. Haga clic en Sí.
31. Vaya a Admin.
32. Haga clic en Arquitecto.
33. Seleccione Invitación a la encuesta en el menú desplegable del flujo.
34. Haga clic en Añadir.
35. Asigne un nombre, una descripción y una división a su flujo.
36. Haga clic en Crear flujo.
37. En la sección Datos de la caja de herramientas, seleccione Llamar acción de datos y arrástrela al cuadro desplegable del flujo.
38. Asigne un nombre a su acción.
39. Para la Categoría, seleccione Acción de datos de servicios web.
40. Para Acción de datos, seleccione la acción de datos que ha creado anteriormente.
41. Junto a cada propiedad, haga clic en el menú desplegable y seleccione Expresión.
42. Para los valores de propiedad, introduzca qué datos se envían para cada propiedad. El cuadro completará automáticamente los campos a medida que escriba.
    Consejo Q: Esta página incluye todas las propiedades predeterminadas en el flujo de invitación a la encuesta. También puede utilizar expresiones complejas en situaciones en las que falta información de contacto del cliente o requiere un formato adicional.
    Consejo Q: La información de contacto está precedida por Encuesta.CustomerContact.
43. Haga clic en la casilla inferior de su flujo.
44. Seleccione Caja de herramientas, después Invitaciones a la encuesta y, a continuación, Cancelar encuesta.
45. Seleccione optOut para la disposición.
46. Haga clic en Publicar. Genesys validará el flujo y luego lo publicará. Una vez hecho esto, el flujo está en marcha y comenzará a enviar encuestas a los clientes cuando completen las interacciones de soporte.

Preguntas frecuentes