Création de webhooks pour les flux de travail
Les webhooks vous permettent d'utiliser les événements système Qlik Cloud comme déclencheurs dans votre flux de travail. Une fois que vous créez un webhook, il envoie automatiquement une demande JSON au point de terminaison du webhook chaque fois que l'événement système défini se produit. Vous pouvez utiliser des webhooks pour envoyer des données d'événement à toute application pouvant recevoir des données JSON.
Propriétés d'un webhook
Pour créer un webhook, vous devez configurer le webhook et les propriétés du point de terminaison et sélectionner les types d'événement Qlik Cloud.
| Propriété | Description |
|---|---|
| Nom | Nom du webhook. |
| Description (facultative) | Description du webhook. |
| URL | URL du point de terminaison du webhook. L'URL (le point de terminaison) du webhook doit être un nom de domaine complet (FDQN) et utiliser le protocole HTTPS. Le point de terminaison ne peut pas être une adresse IP. |
| Secret (facultatif) | Secret pour l'authentification du webhook. Le secret doit être compris entre 32 et 64 caractères. Si vous créez un secret de webhook, il fait partie d'un hashage ajouté à la requête HTTP sous forme de qlik-signature. |
| En-têtes (facultatif) |
En-têtes qui peuvent être ajoutés à la demande HTTP. |
Chaque webhook est configuré avec un ou plusieurs types d'événement.
| Ressource | Types d'événement |
|---|---|
| Applications | Créé, Supprimé, Données mises à jour, Chargé, Publié, Exporté Note InformationsUn événement de mise à jour des données indique que des données sont en cours d'actualisation. Un événement de chargement indique que l'application Qlik Sense et les tables de données associées sont en cours de chargement. |
| Utilisateurs | Créé, Supprimé |
Le webhook attend que l'un des événements se produise et, quand il se produit, il envoie les données d'événement au point de terminaison du webhook. Les données sont transmises à l'URL du point de terminaison sous forme de demande JSON.
Demande JSON d'un type d'événement Application supprimée
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
}
}
}Création d'un webhook
Vous créez des webhooks depuis la Console de gestion. Vous pouvez également créer des webhooks depuis l'interface Automatisation des applications Qlik. Pour plus d'informations, consultez Utilisation de webhooks (uniquement en anglais).
Vous pouvez créer un maximum de 100 webhooks par client.
Procédez comme suit :
-
Dans la Console de gestion, accédez à Webhooks.
-
Dans le coin supérieur droit, cliquez sur Créer.
-
Dans la boîte de dialogue Créer un webhook, saisissez un nom pour le webhook.
-
Ajoutez une description facultative.
-
Saisissez l'URL de l'application d'intégration tierce.
-
En option, vous pouvez saisir le secret à ajouter à la demande HTTP.
-
En option, ajoutez des en-têtes HTTP à la demande.
-
Sous Événements, sélectionnez le type d'événement du webhook.
-
Une fois terminé, cliquez sur Créer.
Les webhooks sont répertoriés dans une table. Par défaut, les nouveaux webhooks créés sont activés.
à la fin de la ligne du webhook et en sélectionnant Activer le webhook ou Désactiver le webhook. Par défaut, les webhooks sont activés. 
en haut de l'une des colonnes pour modifier l'ordre de tri, ou en cliquant sur l'icône de filtre 
en haut de chaque colonne pour rechercher manuellement un webhook. Le filtre de recherche fonctionne pour les correspondances complètes et partielles. Édition d'un webhook
Procédez comme suit :
-
Dans la Console de gestion, accédez à Webhooks.
-
Cliquez sur le bouton
à la fin de la ligne du webhook à modifier. -
Cliquez sur Éditer.
Le volet d'édition apparaît avec des options permettant de modifier la configuration du webhook.
-
Éditez le webhook et cliquez sur Enregistrer.
Suppression d'un webhook
Procédez comme suit :
-
Dans la Console de gestion, accédez à Webhooks.
-
Sélectionnez le webhook à supprimer.
-
Dans le coin supérieur droit, cliquez sur Supprimer.
-
Une boîte de dialogue s'ouvre, vous demandant de confirmer votre choix. Cliquez sur Supprimer.
Affichage de l'historique des webhooks
Vous accédez à l'historique des webhooks sous Webhooks dans la Console de gestion.
-
Pour afficher l'historique d'un webhook, cliquez sur le bouton
à la fin de la ligne du webhook.L'historique du webhook apparaît.
-
Pour renvoyer manuellement une livraison d'événement, cliquez sur le bouton
à la fin de la ligne du webhook. -
Pour afficher la charge utile de la réponse d'un événement, cliquez sur le bouton
à la fin de la ligne de l'événement.