Création et gestion de webhooks pour les flux de travail

Fonctionnement des webhooks

Lorsqu'un événement se produit dans Qlik Cloud (par exemple, une nouvelle application est créée ou un utilisateur est supprimé), un webhook envoie des informations au format JSON à une application externe spécifiée à l'aide d'un rappel (callback) HTTP. Cette application externe peut ensuite utiliser les données de l'événement pour déclencher d'autres actions.

Par exemple :

• Informez votre équipe via Slack en cas de création d'une nouvelle application.

• Envoyez automatiquement un e-mail de bienvenue lors de l'ajout d'un nouveau membre d'équipe à un client.

• Mettez une feuille de calcul à jour lors de la suppression d'un utilisateur du client.

Avantages de l'utilisation des webhooks

Les webhooks permettent une intégration en temps réel à d'autres systèmes, supprimant ainsi le besoin de procéder à des vérifications manuelles constantes ou à des requêtes d'API répétitives. En restant à l'écoute des événements et en envoyant immédiatement les données pertinentes, les webhooks réduisent le travail inutile et permettent une automatisation fluide.

Plateformes populaires pour les intégrations des webhooks

Pour manipuler les données des webhooks et y répondre, vous pouvez créer des services personnalisés ou utiliser des plateformes tierces telles que les suivantes :

• Qlik Application Automation (uniquement en anglais)

• Pipedream

• Zapier

• Microsoft Power Automate

Limites des webhooks

Pour garantir les performances et gérer les ressources du système, les limites suivantes s'appliquent :

• L'historique de fourniture des webhooks est conservé pendant 7 jours.

• Chaque utilisateur peut posséder jusqu'à 150 webhooks.

• Il est possible de créer un maximum de 100 webhooks par client.

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
        }
    }
}

Création de webhooks

Les webhooks peuvent être créées par :

• Les administrateurs de clients à partir du centre d'activités Administration.

• Tous les utilisateurs de l'interface Qlik Application Automation.

Pour plus d'informations sur l'utilisation des webhooks avec Qlik Application Automation, consultez Utilisation des webhooks (uniquement en anglais).

Procédez comme suit :

1. Dans le centre d'activités Administration, accédez à Webhooks.

2. Cliquez sur Créer un nouvel élément.

3. Saisissez un nom pour le webhook et, éventuellement, ajoutez une description.

4. Pour l'URL (le point de terminaison), saisissez le nom de domaine complet (Fully Qualified Domain Name ou FQDN) auquel le webhook enverra les données JSON.

   • Cette URL doit utiliser le protocole HTTPS (exemple : https://domain.com). Les adresses IP ne peuvent pas être utilisées comme points de terminaison de webhook.

5. Vous pouvez éventuellement saisir un secret pour l'authentification du webhook.

   • Le secret doit comporter entre 32 et 64 caractères.

   • S'il est créé, le secret sera inclus dans le cadre d'un hachage, ajouté à la requête HTTP sous forme de qlik-signature.

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

7. Sous Événements, sélectionnez les événements du système qui déclencheront le webhook. Les événements disponibles incluent les événements suivants :

   • Événements liés aux applications : création, suppression, export, mise à jour (actualisation) des données, publication, chargement.

   • Événements liés aux utilisateurs : création, suppression.

8. Cliquez sur Créer.

Gestion des webhooks

Filtrage et recherche de webhooks

Pour trier et rechercher des webhooks dans le tableau :

• Cliquez sur en haut d'une colonne pour modifier l'ordre de tri.

• Cliquez sur en haut d'une colonne pour rechercher un webhook. Le filtre de recherche fonctionne pour les correspondances complètes et partielles.

Activation ou désactivation des webhooks

Procédez comme suit :

1. Dans le centre d'activités Administration, accédez à Webhooks.

2. Cliquez sur à côté du webhook.

3. Pour activer le webhook, sélectionnez Activer le webhook.

4. Pour désactiver le webhook, sélectionnez Désactiver le webhook.

Par défaut, les nouveaux webhooks créés sont activés.

Modification des webhooks

Procédez comme suit :

1. Dans le centre d'activités Administration, accédez à Webhooks.

2. Pour le webhook à modifier, cliquez sur .

3. Sélectionnez Modifier.

4. Modifiez le webhook et cliquez sur Enregistrer.

Suppression de webhooks

Procédez comme suit :

1. Dans le centre d'activités Administration, accédez à Webhooks.

2. Sélectionnez le webhook à supprimer.

3. Cliquez sur Supprimer.

4. Confirmez la suppression.

Affichage de l'historique des webhooks

L'historique des événements des webhooks est conservé pendant 7 jours.

Procédez comme suit :

1. Dans le centre d'activités Administration, accédez à Webhooks.

2. Cliquez sur à côté d'un webhook pour développer l'historique de ses événements.

   

3. Pour renvoyer manuellement une livraison d'événement, cliquez sur  sur la ligne de l'événement.

4. Pour afficher la charge utile de la réponse à un événement, cliquez sur  sur la ligne de l'événement.

   La charge utile affiche des détails tels que l'ID, le nom et l'horodatage de l'application, ce qui s'avère utile pour déboguer ou auditer des événements passés.