Evento JSON
Contenidos de la página
Consejo Q: Los eventos JSON solo están disponibles para los usuarios que hayan adquirido acceso a la API de Qualtrics . Si está interesado en obtener esta función, hable con su Ejecutivo de Cuenta o Servicios de Cuenta.
Acerca del Evento JSON
¿Alguna vez ha deseado que una solicitud realizada en su sitio web activador un ticket en Qualtrics? ¿Alguna vez ha deseado crear una integración perfecta entre Qualtrics y su propio sistema interno? ¿Alguna vez ha deseado activador 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 flujos de trabajo a través de una solicitud HTTP. En lugar de esperar a que un evento en Qualtrics activador más acciones en la plataforma, puede simplemente configurar un evento JSON para recibir solicitudes de un tercero.
Consejo Q: Usted debe generar un token de API antes de que esta función esté disponible para usted. Si ya tienes un token de API, no necesitas generar uno nuevo.
Atención: Configurar un evento JSON requiere conocimientos de programación avanzados. Si bien nuestro equipo de soporte estará encantado de ayudar con los aspectos básicos de la introducción de información en el evento, no podemos brindar asistencia en los aspectos de programación. En cambio, siempre puede preguntar a los usuarios especializados de nuestra comunidad.
Limitaciones
El evento JSON es no compatible con las siguientes configuraciones y configuraciones:
- Cualquier cosa que no sea HTTP (por ejemplo, cola de mensajes, SMS).
- Llamadas HTTP salientes.
- Procesar XML (se ignorará el cuerpo de la solicitud XML ).
- Procesar cualquier cosa que no sea JSON.
- Autenticar de cualquier forma que no sea un encabezado X- API-TOKEN o nuestra autenticación básica HTTP modificada. Consejo Q: OAuth y otras formas de autenticación son incompatibles con los eventos JSON .
- Cualquier análisis JSON que no pueda satisfacerse mediante consultas JSONPath en el cuerpo JSON .
- Llamadas que exceden el límite de velocidad de la API de 3000 por minuto.
- Cargas útiles superiores a 100 KB.
- 10 campos de entrada manual. Consejo Q: Una vez que se extrae la información con captura de evento, se agregará al cuerpo JSON . La captura de Evento es la única forma de agregar más de 10 campos.
Tipos de autenticación admitidos
Autenticación basada en token/autenticación de encabezado
Puedes autenticarte pasando tu token de API a través del encabezado de la solicitud como X- API-TOKEN.
Ejemplo: En el siguiente ejemplo POST, en cURL especificamos la URL base, el tipo de contenido y el token en el encabezado. El ID de la Encuesta y el formato de exportación se especifican en el cuerpo.
curl -X POST -H 'X- API-TOKEN: yourapitokenhere' -H 'Tipo de contenido: aplicación/ json' -d '{
"identificador de encuesta": "SV_012345678912345",
"formato": "csv"
}' 'https: qualtrics.com/ API/v3/responseexports'
Autenticación básica HTTP
La autenticación básica suele ser una versión codificada en Base64 de nombre de usuario:contraseña. Sin embargo, para mejorar la seguridad, Qualtrics utiliza una cadena codificada en Base64 de nombre de usuario:x-api-token.
Para utilizar la autenticación básica, debe configurar encabezados en la solicitud HTTP. El encabezado específico es Autorización .
Ejemplo: Digamos que su nombre de usuario de Qualtrics es demo@ qualtrics.com y su Token de API es f8gIK7G6GFH985Y4. Primero escribirías,
qualtrics:f8gIK7G6GFH985Y4Luego de la codificación Base64, esto aparecería como:
Básico ZGVtb0BxdWFsdHJpY3MuY29tOmY4Z0lLN0c2R0ZIOTg1WTQ=Así que el Autorización El encabezado que agregue a su solicitud HTTP tendrá el valor Básico ZGVtb0BxdWFsdHJpY3MuY29tOmY4Z0lLN0c2R0ZIOTg1WTQ= .
Consejo Q: Consulte estas herramientas para codificación base64 y decodificación base64 .
Configuración de un Evento JSON
Consejo Q : Haga clic en su evento JSON para cambiar los parámetros y los campos JSON .
Atención: Un evento JSON solo se puede activar a través de API desde la misma cuenta que creó el evento. Si se utiliza una cuenta diferente para activar la API para un evento JSON , es posible que aún reciba una respuesta de API de éxito 202; sin embargo, esto significa que se utilizó un token de API válido para realizar una solicitud válida, pero no necesariamente significa que se utilizó el token de API correcto o que el evento JSON se activó correctamente. Si recibe un mensaje de API 202-success, deberá verificar la plataforma para confirmar que se utilizó la API correcta.
Capturando eventos
Al crear un evento de API externo, es posible que necesite analizar datos del cuerpo de la publicación. Sin embargo, a veces puede resultar difícil analizar estos datos. Si desea saber qué está enviando su API externa, siga estos pasos.
Sintaxis de JSONPath
La siguiente tabla proporciona algunos de los conceptos básicos de la sintaxis JSONPath. Tenga en cuenta que estos no están establecidos por Qualtrics, sino que son estándares utilizados con JSON.
Atención: La configuración de un Evento JSON requiere conocimientos avanzados de programación. Si bien nuestro equipo de soporte estará encantado de ayudar con los aspectos básicos de la introducción de información en el evento, no podemos brindar asistencia en los aspectos de programación. Siempre puedes intentar preguntarnos Comunidad de usuarios dedicados en cambio.
| Ruta JSON | Descripción | Ejemplo |
|---|---|---|
| $ | El objeto/elemento raíz | $.tiendas[0].nombre |
| @ | El objeto/elemento actual | $.stores[?(@.name===”Tienda ACME”)] |
| . | Operador infantil | $.descripción del evento |
| .. | Operador descendiente recursivo | $.stores[0]..precio |
| * | Comodín | $.tiendas[*].nombre |
| [] | Operador de subíndice | $.tiendas[0].nombre |
| [,] | Operador sindical | $.tiendas[0,1] |
| [inicio:fin:paso] | Operador de corte de matriz | $.tiendas[0:10:2] |
| ?() | Aplica un filtro | $.stores[?(@.name==”Tienda ACME”)] |
| () | Expresión de script | $.tiendas[(@.length-1)] |
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": "Ingresos mensuales",
"tiendas": [
{
"nombre": "Tienda Acme",
"total": 1000000,
"Artículo superior":
{ "price": "50", "description": "Yunque" }
},
{
"nombre": "El puesto de plátanos",
"total": 250000,
"Artículo superior":
{ "price": "4", "description": "El Gob" }
},
{
"nombre": "Planeta Pizza",
"total": 80000,
"Artículo superior":
{ "precio": "15", "descripción": "Pepperoni" }
}
]
}
Ahora, debemos agregar los valores de retorno que vemos en la tabla JSONPath para que quede más claro.
$ -> Tienda Acme
@ -> [
{
"nombre": "Tienda Acme",
"total": 1000000,
"Artículo superior":
{ "price": "50", "description": "Yunque" }
}
]
. -> Ingresos mensuales
..-> 50
-> ["Tienda Acme", "El puesto de plátanos", "Pizza Planet"]
[] -> Tienda Acme
[,] -> [
Macro desconocida: { "nombre"}
,
Macro desconocida: { "nombre"}
]
**Cambie el ejemplo de [start:end:step] a "$.stores[1:3:1]"
[inicio:fin:paso] -> [
{
"nombre": "El puesto de plátanos",
"total": 250000,
"Artículo superior":
{ "price": "4", "description": "El Gob" }
},
{
"nombre": "Planeta Pizza",
"total": 80000,
"Artículo superior":
{ "precio": "15", "descripción": "Pepperoni" }
}
]
?() -> [{
"nombre": "Tienda Acme",
"total": 1000000,
"Artículo superior":
{ "price": "50", "description": "Yunque" }
}]
() -> [
{
"nombre": "Planeta Pizza",
"total": 80000,
"Artículo superior":
{ "precio": "15", "descripción": "Pepperoni" }
}
] Ejemplo de API en Node Javascript
El siguiente ejemplo es una plantilla básica que puede seguir al formatear los datos de su Evento .
Atención: La configuración de un Evento JSON requiere conocimientos avanzados de programación. Si bien nuestro equipo de soporte estará encantado de ayudar con los aspectos básicos de la introducción de información en el evento, no podemos brindar asistencia en los aspectos de programación. Siempre puedes intentar preguntarnos Comunidad de usuarios dedicados en cambio.
var solicitud = require('solicitud-promesa');
var surveyId = "SV_XXXXXXXXXXXX";
var triggerId = "OC_XXXXXXXXX";
var brandId = "SU_ID_DE_MARCA";
var id_usuario = "UR_XXXXXXXXXXXXXXX";
var centro de datos = "xx1";
var apiToken = "SU_TOKEN_API_QUALTRICS";
var url = "https://" + datacenter + "qualtrics/inbound-event/v1/ evento/ JSON/activadores" +
"?contextId=" + surveyId + "&userId=" + userId + "&brandId=" + brandId + "&triggerId=" + triggerId;
var carga útil = {
"text": "Esto es un texto",
"objeto": {
"número": 4
},
"matriz": ["a", "b", "c", "d"]
};
var opciones = {
url: url,
json: verdadero,
cuerpo: carga útil,
encabezados: {
"Content-Type": "application/ json", // ¡¡¡REQUERIDO!!!
"X- API-TOKEN": apiToken
}
};
solicitud.post(opciones).then(función (ret) {
console.log("éxito:", url, carga útil);
}).catch(función (err) {
console.log("error: ", url);
consola.log(err);
}); Ejemplo: Integración con Freshdesk
Consejo Q: Esto es independiente de la tarea de Freshdesk .
El Evento JSON se puede utilizar para integrarse con Freshdesk como una regla de webhook en Dispatch’r. Esto significa que los eventos en Freshdesk pueden luego activador tareas en Qualtrics, como la creación de un ticket o la distribución de una encuesta.
Consejo Q: El Soporte técnico de Qualtrics puede ayudarlo a configurar su Evento JSON y conectarlo a través de Freshdesk. Sin embargo, es posible que existan algunas preguntas sobre la funcionalidad de Freshdesk que no puedan responder. Si tiene preguntas sobre el lado de Freshdesk, intente consultar su documentación sobre Reglas del despachador .
Consejo Q: Para obtener más información sobre Freshdesk Webhooks , consulte la documentación vinculada en su sitio de soporte.
Ejemplo: Integración con ServiceNow
Consejo Q: Esto es independiente de la Tarea de ServiceNow .
El Evento JSON se puede utilizar para integrarse con ServiceNow. Esto significa que los eventos en ServiceNow pueden luego activador tareas en Qualtrics, como la creación de un ticket o la distribución de una encuesta.
Consejo Q: El Soporte técnico de Qualtrics puede ayudarlo a configurar su Evento JSON y conectarlo a través de ServiceNow. Sin embargo, es posible que existan algunas preguntas sobre la funcionalidad de ServiceNow que no puedan responder. Si tiene preguntas sobre cómo iniciar sesión y activar su instancia de desarrollador de ServiceNow, intente consultar su documentación sobre Instancias de desarrollador personal .
Ejemplo: Integración con Microsoft Dynamics a través de Microsoft Flow
Consejo Q: Esto es independiente de la Tarea de Microsoft Dynamics .
El Evento JSON hace que los eventos en Microsoft Dynamics puedan luego activador tareas en Qualtrics, como la creación de un ticket o la distribución de una encuesta. Por ejemplo, cada vez que elimina un registro de cuenta en Microsoft, puede distribuir una encuesta de Qualtrics al propietario de la cuenta que haga 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 ocurren en Microsoft Dynamics, en realidad necesita realizar la configuración dentro de Microsoft Flow en lugar de Dynamics. No se preocupe: Microsoft Flow viene gratis con cada cuenta de Microsoft Dynamics, por lo que puede iniciar sesión en Flow con su información de Dynamics. aquí .
Consejo Q: El Soporte técnico de Qualtrics puede ayudarlo a configurar su Evento JSON y conectarlo a través de Microsoft Flow y Microsoft Dynamics. Sin embargo, es posible que existan algunas preguntas sobre la funcionalidad de Microsoft que no puedan responder. Si tiene preguntas sobre el lado de Microsoft, intente consultar su documentación. Fluir y sus recurso para Dinámica .
Consejo Q: Se prefiere Microsoft Flow para estos pasos porque puede enviar más información a Qualtrics en el cuerpo JSON . Si configura esto dentro de Microsoft Dynamics en lugar de Flow, solo los campos modificados durante el evento de Dynamics se enviarán a Qualtrics. Por ejemplo, si elige activador en función de una actualización de registro y solo se cambia un campo de “correo electrónico”, el “nombre” y la “dirección” no se enviarán a Qualtrics, incluso si solicita específicamente esos campos en el cuerpo. Flow enviará todo lo que usted solicitó a Qualtrics, independientemente de si ese campo se modificó en el evento desencadenante.
Ejemplo: Integración con Genesys PureCloud
Consejo Q: Para configurar esta integración, debe tener acceso a Genesys Cloud Architect y Genesys Web Service Data Actions.
Al utilizar eventos JSON , puede integrarse con Genesys PureCloud para enviar a los clientes una encuesta de seguimiento después de completar una interacción de soporte telefónico o de chat.
Preguntas frequentes
¿El evento JSON me permite integrar con _?
¿El evento JSON me permite integrar con _?
- Se puede configurar para realizar llamadas HTTP POST salientes (por ejemplo, webhooks, aplicación personalizada)
- Puede autenticarse pasando un token de cabecera
- Fija la cabecera Tipo de contenido en "application/json" y formatea los cuerpos de la solicitud como JSON válido (opcional para Datos de evento)
¿Cuántos eventos por minuto puedo llevar a cabo en mi evento JSON (op_start) antes de lanzarme?
¿Cuántos eventos por minuto puedo llevar a cabo en mi evento JSON (op_start) antes de lanzarme?
¿Cómo sé si falla mi flujo de trabajo de evento JSON?
¿Cómo sé si falla mi flujo de trabajo de evento JSON?
¿Qué son los flujos de trabajo? / ¿Dónde están las acciones?
¿Qué son los flujos de trabajo? / ¿Dónde están las acciones?
No hay cambios en la funcionalidad del flujo de trabajo como parte de esta actualización.
¡Genial! ¡Gracias por tus comentarios!
¡Gracias por tus comentarios!