Accéder au contenu principal

Création de webhooks pour les flux de travail

Les webhooks vous permettent d'utiliser les événements système Qlik Sense 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 Sense.

Propriétés d'un webhook
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 demande HTTP sous forme de signature qlik.
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.

Types d'événement des webhooks
Ressource Types d'événement
Applications Créé, Supprimé, Données mises à jour, Chargé, Publié, Exporté
Remarque: Un é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.

Remarque: Pour en savoir plus sur les charges utiles des événements, voir le Portail des développeurs Qlik : Événements API.

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 Management Console, sous Intégration > Webhooks.

Remarque: Vous pouvez créer un maximum de 100 webhooks par client.
  1. Dans le coin supérieur droit, cliquez sur Créer.

  2. Dans la boîte de dialogue Créer un webhook, saisissez un nom pour le webhook.

  3. Ajoutez une description facultative.

  4. Saisissez l'URL de l'application d'intégration tierce.

  5. En option, vous pouvez saisir le secret à ajouter à la demande HTTP.

  6. En option, ajoutez des en-têtes HTTP à la demande.

  7. Sous Événements, sélectionnez le type d'événement du webhook.

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

Tableau de webhooks dans Management Console
Conseil: Vous pouvez activer ou désactiver un webhook en cliquant sur le bouton Icône d'IU représentant trois points permettant d'ouvrir le menu d'options du webhook à 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.
Conseil: Vous pouvez trier et rechercher des webhooks dans la table en cliquant sur l'icône Icône de flèche vers le haut/bas permettant de trier les valeurs des colonnes en haut de l'une des colonnes pour modifier l'ordre de tri, ou en cliquant sur l'icône de filtre Icône de filtre en haut de chaque colonne de webhooks 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

Vous éditez des webhooks depuis Management Console, sous Intégration > Webhooks.

  1. Cliquez sur le bouton Icône d'IU représentant trois points permettant d'ouvrir le menu d'options du webhook à la fin de la ligne du webhook que vous souhaitez éditer.

  2. Cliquez sur Éditer.

    Le volet d'édition apparaît avec des options permettant de modifier la configuration du webhook.

  3. Éditez le webhook et cliquez sur Enregistrer.

Suppression d'un webhook

Vous supprimez des webhooks depuis Management Console, sous Intégration > Webhooks.

  1. Sélectionnez le webhook à supprimer.

  2. Dans le coin supérieur droit, cliquez sur Supprimer.

  3. 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 depuis Management Console, sous Intégration > Webhooks.

Remarque: Les livraisons d'événements sont supprimées de l'historique des webhooks au bout de 7 jours.
  • Pour afficher l'historique d'un webhook, cliquez sur le bouton Icône d'IU de flèche vers le bas permettant de développer le menu Webhook à la fin de la ligne du webhook.

    L'historique du webhook apparaît.

    Historique du webhook dans Management Console

  • Pour renvoyer manuellement une livraison d'événement, cliquez sur le bouton Icône de renvoi permettant de renvoyer le webhook à la fin de la ligne du webhook.

  • Pour afficher la charge utile de la réponse d'un événement, cliquez sur le bouton Icône d'IU de flèche vers le bas permettant de développer le menu Charge utile de l'événement à la fin de la ligne de l'événement.

    Informations sur la charge utile du type d'événement du webhook dans Management console