Webhooks salientes

Acerca de los Webhooks Salientes

En términos generales, un webhook es la manera en que las aplicaciones se comunican automáticamente entre sí. En otras palabras, se envía un mensaje a través de la web, el cual se activa automáticamente siempre que ocurre un evento específico. La automatización de un webhook saliente se detona cuando un encuestado completa tu encuesta y su respuesta se envía a un sistema externo de tu elección.

Cada vez que la automatización de un webhook saliente se activa, se crea una nueva ejecución de automatización. Estas ejecuciones representan instancias en las que tu webhook saliente envía una respuesta de encuesta al sistema externo especificado. Con Enalyzer, puedes visualizar y gestionar fácilmente tus ejecuciones de automatización.

Los webhooks están destinados para usuarios que saben cómo manejarlos. Ten en cuenta que no podemos solucionar problemas de tu código ni proporcionar instrucciones de desarrollo paso a paso.

Crear una Automatización de Webhook Saliente

Para configurar una automatización de webhook saliente, tienes que:

1. Ir al área de automatizaciones () y hacer clic en Enalyzer en el menú lateral.
2. En el menú lateral, haz clic en Enalyzer.
3. Haz clic en crear automatización. Si ya tienes una o más automatizaciones, haz clic en el icono de añadir automatización () para añadir una automatización.
4. Selecciona la opción de webhooks y haz clic en webhook saliente.
5. Elige qué variables quieres incluir en tu transferencia. Puedes elegir incluir todas las variables o variables específicas en tu transferencia de datos.
   1. Esta opción incluirá todas tus preguntas de la encuesta y variables de fondo en la transferencia de datos.
      1. Usa el menú desplegable para seleccionar la opción incluir todas las variables
      2. Haz clic en siguiente.
   2. Esta opción te permite seleccionar qué preguntas de la encuesta y variables de fondo incluir en tu transferencia de datos.
      1. Usa el menú desplegable para seleccionar la opción incluir variables específicas y haz clic en siguiente.
      2. Selecciona las preguntas y variables de fondo que quieras incluir en tu transferencia de datos y haz clic en añadir.
6. Selecciona las etiquetas de las variables que el webhook debería usar. Puedes seleccionar entre:
   • Etiquetas auto-generadas: estas son generadas por Enalyzer y son las mismas etiquetas que las auto-generadas en las descargas de datos de respuestas.
   • Etiquetas de datos: Puedes usar etiquetas de datos que puedes personalizar tú mismo en la configuración de tu encuesta. 
7. Añade la URL a la cual la automatización de webhook enviará los datos.
8. Haz clic en el botón de probar conexión. Una vez que tu conexión sea exitosa, haz clic en siguiente.
9. Nombra tu automatización y haz clic en siguiente.
10. Establece el estado de la automatización. Por defecto está habilitada, sin embargo, puedes deshabilitarla antes de crearla.
11. Cuando estés listo para crear tu automatización, haz clic en hecho.

Personalizar Etiquetas de Datos

Cuando creas una variable de fondo o pregunta, Enalyzer genera automáticamente una etiqueta que puedes encontrar en las descargas de datos de respuestas. Las etiquetas de datos te permiten personalizar las etiquetas para tus variables de fondo de encuesta y preguntas para webhooks salientes con el fin de controlar la salida de las llamadas a la API.

Tus etiquetas de datos se definen bajo la configuración de tu encuesta, todo lo que tienes que hacer es:

1. Ir al área de encuestas () y abrir tu encuesta.
2. En el menú lateral, haz clic en configuración.
3. Bajo configuración de datos, haz clic en etiquetas de datos.
4. Verás una visión general de todas las variables de encuesta (variables de fondo y elementos de pregunta) en el lado izquierdo. En el lado derecho, verás tus etiquetas de datos. Por defecto, las etiquetas de datos se generan automáticamente, basadas en las correspondientes variables de fondo/elementos de la encuesta, sin embargo, puedes definir tus propios valores.

Las etiquetas de datos tienen que ser únicas, no pueden contener caracteres especiales y están limitadas a 100 caracteres.

Las etiquetas de datos solo se pueden definir para variables de fondo y preguntas pero no para opciones de respuesta.

Las etiquetas de datos no se copian al copiar preguntas, pero sí se copian al copiar encuestas o cuando la encuesta se comparte como una plantilla.

Detalles de la Ejecución de Automatización

Cada vez que se ejecuta la automatización de webhook saliente se crea una nueva ejecución. Las ejecuciones de automatización son las instancias cuando tu webhook saliente transfiere una respuesta de la encuesta al sistema externo especificado. Una vez que la automatización de webhook saliente comienza a funcionar, puedes ver las ejecuciones de automatización que crea. Cada ejecución de automatización puede tener un estado diferente. Los posibles estados son:

• Programado: la automatización de webhook saliente ha sido programada para un momento posterior, pero aún no se ha ejecutado.
• Fallido: la automatización de webhook saliente ha encontrado un error y no se pudo ejecutar.
• En ejecución: la automatización de webhook saliente está actualmente en ejecución.
• Exitoso: la automatización de webhook saliente se completó con éxito y la respuesta de la encuesta fue enviada al sistema externo.

Para ver detalles sobre una ejecución de automatización, todo lo que tienes que hacer es:

1. Ir al área de automatizaciones () y hacer clic en Enalyzer en el menú lateral.
2. En el menú lateral, hacer clic en Enalyzer.
3. Hacer clic en la automatización.
4. Bajo registro, hacer clic en ejecuciones de automatización.
5. Para ver los detalles de una ejecución de automatización, simplemente haz clic en la ejecución.
6. Los detalles de la ejecución de automatización incluyen:
   • Nombre y apellido: la ejecución mostrará el nombre y apellido del encuestado si está disponible.
   • Estado: el estado de la ejecución, así como la fecha y hora en que obtuvo ese estado.
   • Hora de creación: la fecha y hora en que se creó la ejecución.
   • URL de envío: la URL a la que se publicó la respuesta de la encuesta.
   • Mensaje saliente: los datos que se enviaron al sistema externo.

Las ejecuciones de encuestas anónimas no mostrarán los nombres, apellidos o correos electrónicos de los encuestados. En su lugar, la ejecución se nombrará como "Anónimo".

Filtrar Ejecuciones de Automatizaciones

Puedes filtrar tus ejecuciones de automatización por estado, período de tiempo o nombre. Esto te ayudará a ordenar tus ejecuciones y hacerlas más fáciles de administrar, por ejemplo, puedes encontrar todas las ejecuciones fallidas y ver qué sucedió o volver a ejecutarlas.

Para filtrar tus ejecuciones de automatización, tienes que:

1. Ir al área de automatizaciones () y hacer clic en Enalyzer en el menú lateral.
2. En el menú lateral, hacer clic en Enalyzer.
3. Hacer clic en la automatización.
4. Bajo log, hacer clic en ejecuciones de automatización.
5. Haz clic en el botón de filtro.
6. Tienes las siguientes opciones para filtrar ejecuciones, y puedes añadir tantos filtros como sea necesario para profundizar en ellas:
   • Buscar por nombre o dirección de correo electrónico: Escribe una dirección de correo electrónico o un nombre en el campo de búsqueda. Esto se refiere al valor de la respuesta de la encuesta.
   • Estado: Filtrar por el estado de la ejecución.
   • Período de tiempo: Filtrar por el período de tiempo basado en la fecha de creación de la ejecución.
     

     Las ejecuciones de automatización solo se almacenan durante 14 días, por lo tanto, el filtro de período de tiempo está limitado a 14 días en el pasado.

7. Una vez que hayas terminado de añadir todos los filtros, haz clic en el botón aplicar para filtrar la lista de ejecuciones de automatización y cerrar el menú lateral de edición de filtros de ejecuciones.

Reproducción Automática de Ejecuciones

Hay múltiples razones por las que querrías repetir una ejecución. La más común es si ha fallado, sin embargo, puede que quieras enviar los datos de nuevo o ejecutar una que ha sido programada para más tarde. Para repetir tus ejecuciones, todo lo que tienes que hacer es:

1. Ir al área de automatizaciones () y hacer clic en Enalyzer en el menú lateral.
2. En el menú lateral, haz clic en Enalyzer.
3. Haz clic en la automatización.
4. Debajo de registro, haz clic en ejecuciones automáticas.
5. Haz clic en el menú de acciones y selecciona reproducir.
6. Selecciona la(s) ejecución(es) que te gustaría repetir y haz clic en el botón reproducir.

Recibir Notificaciones de Errores

Los webhooks salientes pueden fallar por diferentes motivos y causar que tu automatización se desactive. Sea cual sea el motivo, puedes habilitar notificaciones de error por correo electrónico para tu automatización. Puedes definir la(s) persona(s) que necesita(n) recibir estas notificaciones.

Para habilitar las notificaciones de error, tienes que:

1. Ir al área de automatizaciones () y hacer clic en Enalyzer en el menú lateral.
2. Hacer clic en la automatización para la cual quieres habilitar notificaciones de error.
3. Bajo notificaciones de errores, habilitar la configuración de notificaciones por correo electrónico.
4. Hacer clic en agregar destinatario e introducir la dirección de correo electrónico que recibirá los correos de notificación de errores. Repetir este paso para agregar más destinatarios.
5. Tus cambios se guardarán inmediatamente.