Crear y administrar webhooks para flujos de trabajo

Permisos requeridos de webhooks

Al crear o gestionar webhooks utilizando la API de Webhooks de Qlik Cloud y la IU de automatizaciones, debe solicitar uno o ambos de estos permisos:

• Utilizar webhooks: Necesario para crear, ver, actualizar y eliminar webhooks propiedad del usuario.

• Administrar Webhooks: Necesario para gestionar todos los webhooks del espacio empresarial inquilino, incluidos los creados por otros usuarios.

Cómo funcionan los webhooks

Cuando se produce un evento en Qlik Cloud (por ejemplo, se crea una nueva aplicación o se elimina un usuario), un webhook envía información en formato JSON a una aplicación externa especificada mediante una devolución de llamada HTTP. Esta aplicación externa puede utilizar entonces los datos de los eventos para desencadenar otras acciones.

Por ejemplo:

• Notifique a su equipo a través de Slack cuando se cree una nueva aplicación.

• Enviar automáticamente un correo electrónico de bienvenida cuando se añade un nuevo miembro a un espacio empresarial inquilino.

• Actualizar una hoja de cálculo cuando se elimina un usuario del espacio empresarial inquilino.

Ventajas de usar webhooks

Los webhooks permiten la integración en tiempo real con otros sistemas, eliminando la necesidad de comprobaciones manuales constantes o solicitudes de API repetitivas. Al estar a la escucha de los eventos y enviar inmediatamente los datos pertinentes, los webhooks reducen el trabajo innecesario y permiten una automatización sin problemas.

Plataformas habituales de integración de webhooks

Para gestionar y responder a los datos de webhooks, puede crear servicios personalizados o utilizar plataformas de terceros como:

• Qlik Automate (solo en inglés)

• Pipedream

• Zapier

• Microsoft Power Automate

https://<your-tenantURL>/api/v1/webhooks/{id}

{
    "Content-Type": "application/json",
    "X-Execution-Token: <your-execution-token>",
    "Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",
    "User-Agent": "Qlik Webhook"
}

{
    "cloudEventsVersion": "0.1",
    "source": "com.qlik/engine",
    "contentType": "application/json",
    "eventId": "e65c1481-e8a-4be-a5ca-27dfcde077d7",
    "eventTime": "2021-03-08T14:51:29Z",
    "eventTypeVersion": "1.0.0",
    "eventType": "com.qlik.v1.app.deleted",
    "extensions": {
        "ownerId": "vNRGrDZIypJzauw59BbpvkRhqbmI",
        "tenantId": "oZcMPa_1PwH4FUdrh6839YHHdEJN",
        "userId": "vNRGrDZIypJtcGTzauw59BbpqbmI"
    },
    "data": {
        "attributes": {
            "id": "0984fec4-aa8c-4253-b1d1-4fd4f9c78",
            "name": "New App",
            "createdDate": "2021-03-08T14:51:28.888Z",
            "modifiedDate": "2021-03-08T14:51:29.316Z",
            "owner": "auth0|b62a17c577a4abe6e807b07d18c4d82286352542d633d120100b03fb11",
            "ownerId": "vNRGrDZIypJtcGTzauw59BbpvbmI",
            "published": false,
            "hasSectionAccess": false
        }
    }
}

Crear webhooks

Los webhooks los pueden crear:

• Administradores de espacios empresariales inquilinos desde el centro de actividades Administración.

• Todos los usuarios desde la interfaz Qlik Automate.

Para más información sobre el uso de webhooks con Qlik Automate, consulte Trabajar con webhooks (solo en inglés).

Haga lo siguiente:

1. En el centro de actividades Administración, vaya a Webhooks.

2. Haga clic en Crear nuevo.

3. Indique un nombre para el webhook y, si lo desea, añada una descripción.

4. Para URL (el punto de conexión), indique el nombre de dominio completo (FQDN) donde el webhook enviará los datos JSON.

   • Esta URL debe utilizar el protocolo HTTPS (ejemplo: https: //domain.com). Las direcciones IP no pueden usarse como puntos de conexión de webhooks.

5. Opcionalmente, introduzca un secreto para la autenticación de webhooks.

   • El secreto debe tener entre 32 y 64 caracteres.

   • Si lo crea, el secreto se incluirá como parte de un hash, anexado a la solicitud HTTP como qlik-signature.

6. Evento en la nube: la carga útil del evento emitida por el servicio de webhooks de Qlik Cloud. Una vez activado y guardado, el cambio no se puede deshacer.

7. Comprobar revocación de certificado cuando está activado, verifica que los certificados del webhook sean válidos y no estén revocados.

8. Opcionalmente, añada cabeceras HTTP para anexar a la solicitud. Marque la casilla de verificación para cifrar el valor del encabezado.

   Nota informativaPor motivos de seguridad, no puede editar encabezados cifrados. Para eliminar el encabezado, haga clic en el icono de eliminación. Para eliminar el valor, haga clic en el icono Eliminar y escriba uno de nuevo.

9. En Eventos, seleccione los eventos del sistema que activarán el webhook. Para filtrar un evento, consulte Añadir filtros a eventos.

   Entre los eventos disponibles se incluyen:

   • Eventos de automatización

   • Eventos de API

   • Eventos de aplicación

   • Eventos de integración de datos

   • Eventos de usuario

10. Haga clic en Crear.

Añadir filtros a eventos

Puede añadir un filtro al crear o editar un webhook. Un filtro solo envía datos cuando el evento seleccionado coincide con las condiciones del filtro.

Aparece un icono de filtro junto a una categoría de eventos cuando un evento de esa categoría tiene un filtro.

Haga lo siguiente:

1. En la sección Eventos, seleccione un evento que admita filtrado. El botón Añadir filtro aparece cuando selecciona un evento compatible.

2. Haga clic en Añadir filtro.

   Nota informativaUn webhook con un filtro solo puede tener un evento seleccionado. Añadir un filtro deshabilita cualquier otro evento seleccionado. Si ya ha seleccionado otros eventos, un cuadro de diálogo de confirmación le informa de que se desmarcarán.

3. En el generador de filtros, seleccione un campo, operador y valor.

   • Los campos disponibles dependen del evento seleccionado.

   • El control de valor disponible depende del campo seleccionado. Puede seleccionar un valor de la lista, buscar un recurso o introducir un valor manualmente.

4. Para añadir una condición al grupo, haga clic en Añadir condición. Seleccione y u o para definir cómo se combinan las condiciones.

5. Para añadir un grupo de condiciones, haga clic en Añadir grupo. Seleccione y u o para definir cómo se combinan los grupos.

6. Revise la vista previa de Expresión de filtro.

   Nota informativaLa expresión de filtro se muestra para la resolución de problemas y la validación, y no se puede editar. Para cambiar el filtro, utilice el generador de filtros. Una expresión de filtro puede contener hasta 512 caracteres.

7. Cree o guarde el webhook.

Ejemplo

Para recibir eventos solo cuando una recarga se complete correctamente, cree un filtro para el evento Tarea de recarga completada. La expresión de filtro resultante es: data.status eq "SUCCEEDED"

Eventos que no admiten filtrado

No se admite el filtrado para los siguientes eventos:

• Actualizado el modelo de datos de la aplicación
• Error en la validación de la clave de API
• Creada una automatización
• Eliminada una automatización
• Actualizada una automatización
• Usuario creado
• Usuario eliminado

Administrar webhooks

Nota informativa

Los webhooks creados con Qlik Automate solo se pueden ver en el centro de actividades Administración. No se pueden editar, eliminar, habilitar ni deshabilitar.

Para administrar estos webhooks, utilice la interfaz de Qlik Automate.

Ordenar y buscar webhooks

Para ordenar y buscar webhooks en la tabla:

• Haga clic en en la parte superior de una columna para cambiar el orden.

• Haga clic en en la parte superior de una columna para buscar un webhook. El filtro de búsqueda funciona para correspondencias completas y parciales.

Activar o desactivar webhooks

Haga lo siguiente:

1. En el centro de actividades Administración, vaya a Webhooks.

2. Haga clic en junto al webhook.

3. Para activar el webhook, seleccione Habilitar.

4. Para desactivar el webhook, seleccione Deshabilitar.

Los webhooks recién creados están habilitados de manera predeterminada.

Editar webhooks

Haga lo siguiente:

1. En el centro de actividades Administración, vaya a Webhooks.

2. Para el webhook que desea editar, haga clic en .

3. Seleccione Editar.

4. Edite lo que desee y haga clic en Guardar.

Nota informativaSi hace clic en Cancelar mientras hay cambios sin guardar, aparece un cuadro de diálogo de confirmación. Haga clic en Descartar para cerrar sin guardar los cambios.

Eliminar webhooks

Haga lo siguiente:

1. En el centro de actividades Administración, vaya a Webhooks.

2. Seleccione el webhook que desee eliminar.

3. Haga clic en Eliminar.

4. Confirme la eliminación.

Nota informativaEl botón Eliminar no está disponible hasta que seleccione uno o más webhooks. La barra de acciones muestra el número de webhooks seleccionados.

Ver el historial de webhooks

El historial de eventos de webhooks se conserva durante 7 días.

Haga lo siguiente:

1. En el centro de actividades Administración, vaya a Webhooks.

2. Haga clic en junto a un webhook para ampliar su historial de eventos.

   

3. Para reenviar manualmente la entrega de un evento, haga clic en en la fila de eventos.

4. Para ver la carga útil de la respuesta al evento, haga clic en en la fila del evento.

   La carga útil muestra detalles como el ID de la aplicación, el nombre y la fecha y hora, lo que resulta útil para depurar o auditar eventos pasados.