Crear y administrar webhooks para flujos de trabajo

Cómo funcionan los webhooks

Cuando se produce un evento en Qlik Cloud (por ejemplo, se crea una nueva app 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:

• Notificar a su equipo en Slack cuando se cree una nueva app.

• 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 Application Automation (solo en inglés)

• Pipedream

• Zapier

• Microsoft Power Automate

Límites de los webhooks

Para mantener el rendimiento del sistema y administrar los recursos, se aplican los siguientes límites:

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

• Cada usuario puede poseer hasta 150 webhooks.

• Se puede crear un máximo de 100 webhooks por espacio empresarial inquilino.

https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx

{
    "Content-Type": "application/json",
    "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 de Qlik Application Automation.

Para más información sobre el uso de webhooks con Application Automation, 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. Opcionalmente, añada cabeceras HTTP para anexar a la olicitud.

7. En Eventos, seleccione los eventos del sistema que activarán el webhook. Entre los eventos disponibles se incluyen:

   • Eventos de app: creada, eliminada, exportada, datos actualizados, publicada, recargada.

   • Eventos de usuario: creado, eliminado.

8. Haga clic en Crear.

Administrar webhooks

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 webhook.

4. Para desactivar el webhook, seleccione Deshabilitar webhook.

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.

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.

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 app, el nombre y la fecha y hora, lo que resulta útil para depurar o auditar eventos pasados.