Microaplicaciones

Configurar escuchas de webhook

Configure las escuchas de webhook (también conocidas como API de inserción HTTP) para permitir que sus microaplicaciones proporcionen datos casi en tiempo real a los usuarios finales. La configuración de un webhook permite a sus aplicaciones entregar datos a otras aplicaciones a una velocidad mucho mayor que la sincronización desde el lado de la plataforma de microaplicaciones. El tamaño máximo de un cuerpo de solicitud de webhook que el servidor de microaplicaciones puede manejar es 64 kb.

Para agregar escuchas, debe estar familiarizado con la aplicación de destino “Sistema de registro” (SoR) y tener las herramientas y los privilegios de administración necesarios definidos para configurar sus webhooks en esas ubicaciones.

Configure sus webhooks después de haber configurado su integración a través de Carga de datos y siga estos pasos:

  1. Haga clic en Escuchas de webhooks en la barra izquierda de la pantalla Integración HTTP:

    Escuchas de webhooks

  2. Introduzca el nombre del webhook deseado.
  3. Seleccione Copiar para copiar la URL del webhook que se utilizará en la interfaz de administración del sistema de registro de destino.

Método de autorización

Al configurar el método de autorización, puede seleccionar Token o Ninguno. Para configurar el método Token siga estos pasos:

  1. Seleccione Token en el menú Método de autorización.
  2. Seleccione Generar token y, a continuación, Copiar para agregar el token al portapapeles y usarlo en la interfaz de administración del sistema de registro de destino.
  3. Seleccione Leer token de para elegir:

    • Encabezado personalizado
    • Parámetro de la consulta
    • Encabezado de la autorización
  4. Defina el Nombre o el Prefijo según el método de lectura seleccionado.

El token ya está configurado.

Métodos de solicitud

Al configurar sus escuchas de webhooks, utilice las siguientes definiciones para crear las llamadas:

  • PUT se utiliza para actualizar el recurso existente.
  • POST crea nuevos recursos subordinados; por lo tanto, los métodos POST se utilizan para crear un nuevo recurso en la colección de recursos. Tanto PUT como POST eliminan datos de las tablas secundarias mediante la información de clave principal de la tabla raíz. A continuación, reemplazan un registro existente o insertan uno nuevo.
  • DELETE se utiliza para eliminar recursos. DELETE tiene dos extremos:
    • {serviceUuid}/{webhookListenerUuid}/{recordId}, donde recordId es el valor de la clave principal del registro en la tabla raíz que se va a eliminar. Los registros de la tabla secundaria se eliminan en consecuencia.
    • {serviceUuid}/{webhookListenerUuid}/?id1=1&id2=1, donde id1 y id2 representan los valores de la clave principal compuesta del registro en la tabla raíz que se va a eliminar. Los registros de la tabla secundaria se eliminan en consecuencia.
  • Las solicitudes PATCH se utilizan para hacer actualizaciones parciales en un recurso.

Definir estructura de datos

Puede definir la estructura de datos siguiendo un método similar al descrito al Obtener estructura de datos durante la configuración de Carga de datos. Para obtener más información, consulte Configurar la integración.

Para definir la estructura de datos de webhook, siga estos pasos:

  1. Establezca el período de retención de datos deseado. Se eliminan todas las entradas anteriores a esta fecha. Cada entrada guardada contiene la fecha y hora de modificación. Es decir, lastModified. Esta fecha y hora se utilizan para decidir qué entradas se van a eliminar.
  2. Seleccione Generar tablas.

    Se abrirá la pantalla Generar tablas.

    Pegue su solicitud de muestra JSON desde la aplicación de destino Sistema de registro (SoR) aquí.

  3. Establezca el nombre base de las tablas creadas.
  4. (Opcional) Establezca la ruta de acceso raíz si es necesario.
  5. Seleccione Generar.

Con este proceso completado, junto con las medidas de configuración en la administración de la aplicación de destino Sistema de registro, seleccione Agregar.

Su webhook ahora está configurado.

Compatibilidad con scripts

Las escuchas de webhooks admiten scripts personalizados configurados en la funcionalidad Scripts de integración HTTP.

Dispone de información adicional sobre el desarrollo e implementación de sus propios scripts en Citrix Developer Portal.

Mostrar registros de webhook

Utilice los registros de webhook para ver un historial de solicitudes y errores de todos los dispositivos de punto final de webhook. Puede filtrar por nombre y estado de webhook, como correcto, error o todos. Para mejorar el rendimiento, solo se conservan las 10 últimas entradas de los registros de webhook para su revisión en la pantalla de registros de webhooks.

  1. En la página Administrar microaplicaciones, seleccione el menú situado junto a la integración de la que quiere ver los registros de integración.
  2. Seleccione Registros de webhook.
  3. Revise las entradas y seleccione en el menú los filtros necesarios.
Configurar escuchas de webhook