Crear webhooks para flujos de trabajo
Los webhooks le ofrecen una manera de utilizar los eventos del sistema de Qlik Cloud como disparadores o desencadenantes de eventos en su flujo de trabajo. Una vez que crea un webhook, este envía automáticamente un espacio JSON al extremo del webhook cada vez que ocurre el evento definido del sistema. Puede utilizar webhooks para enviar datos de eventos a cualquier aplicación que pueda recibir datos JSON.
Si su espacio inquilino está utilizando la nueva experiencia de navegación, el centro de actividades de Administración reemplaza a la Consola de gestión.
Para más información, vea Nueva plataforma de navegación.
Propiedades de webhook
Para crear un webhook, debe configurar las propiedades del webhook y del punto final o extremo, y elegir los tipos de eventos de Qlik Cloud .
Propiedad | Descripción |
---|---|
Nombre | Nombre del webhook. |
Descripción (opcional) | Descripción del webhook. |
URL | Una URL para el extremo de webhook. La URL (extremo del webhook) debe ser un nombre de dominio completo (FDQN) y debe utilizar el protocolo HTTPS. El extremo no puede ser una dirección IP. |
Secreto (opcional) | El secreto para la autenticación del webhook. El secreto debe tener un mínimo de 32 caracteres y un máximo de 64 caracteres. Si crea un secreto de webhook, es parte de un hash que se agrega a la solicitud HTTP como una firma qlik-signature. |
Encabezados (opcional) |
Encabezados que se pueden agregar a la solicitud HTTP. |
Cada webhook está configurado con uno o más tipos de eventos.
Recurso | Tipo de evento |
---|---|
Apps de | Crear, Eliminar, Actualizar datos, Recargar, Publicar, Exportar Nota informativaUn evento de actualización de datos se refiere a la actualización de los datos. Un evento de recarga se refiere a la Qlik Sense de Qlik Cloud y a las tablas de datos asociadas se están cargando. |
Usuarios | Crear, Eliminar |
El webhook espera a que se produzca uno de los eventos y, cuando lo hace, envía los datos del evento al punto de conexión del webhook. Los datos se pasan a la URL del extremo como una solicitud JSON.
Ejemplo: Solicitud JSON para el tipo de evento eliminado de la app
Request
URL
https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx
Headers
{
"Content-Type": "application/json",
"Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",
"User-Agent": "Qlik Webhook"
}
Body
{
"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
}
}
}
Cómo crear un webhook
Puede crear webhooks desde Consola de gestión. También puede crear webhooks desde la interfaz de Automatización de aplicaciones de Qlik. Para más información, vea Trabajar con webhooks (solo en inglés).
Puede crear un máximo de 100 webhooks para cada espacio empresarial inquilino.
Haga lo siguiente:
-
En la Consola de gestión, vaya a Webhooks.
-
En la esquina superior derecha, haga clic en Crear nuevo.
-
En el cuadro de diálogo Crear webhook, escriba un nombre para el webhook.
-
Añada una descripción opcional.
-
Inserte la URL de la aplicación de integración de terceros.
-
Opcionalmente, inserte el secreto para agregarlo a la solicitud HTTP.
-
Opcionalmente, agregue encabezados HTTP para agregar a la solicitud.
-
En Eventos, seleccione el tipo de evento para el webhook.
-
Cuando termine, haga clic en Crear.
Los webhooks aparecen listados en una tabla. Los webhooks recién creados están activados de forma predeterminada.
Editar un webhook
Haga lo siguiente:
-
En la Consola de gestión, vaya a Webhooks.
-
Para el webhook que desee editar, haga clic en el botón al final de la fila.
-
Haga clic en Editar.
El panel de edición se muestra con opciones para cambiar la configuración del webhook.
-
Edite lo que desee y haga clic en Guardar.
Eliminar un webhook
Haga lo siguiente:
-
En la Consola de gestión, vaya a Webhooks.
-
Seleccione el webhook que desee eliminar.
-
En la esquina superior derecha, haga clic en Eliminar.
-
Se abre un cuadro de diálogo emergente para confirmar su elección. Haga clic en Eliminar.
Ver el historial de webhooks
Puede acceder al historial de webhooks desde Webhooks en la Consola de gestión.
-
Para ver el historial de webhooks, haga clic en el botón al final de la fila de webhooks.
Se muestra el historial de webhooks.
-
Para reenviar manualmente la entrega de un evento, haga clic en el botón al final de la fila de webhooks.
-
Para ver la carga útil de respuesta al evento, haga clic en el botón al final de la fila de webhooks.