Configurer un événement webhook

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 5 minutes de lecture
  • Configurez un événement d’API Webhook dans la table de configuration du fournisseur pour permettre aux fournisseurs de badges de partager les données de badgeage collectées à partir des tables de badges à l’aide de l’événement webhook.

    Avant de commencer

    Rôle requis : sn_wsd_wc.admin

    Pourquoi et quand exécuter cette tâche

    Les données de badgeage (JSON) sont traitées à l’aide de l’explorateur d’API ServiceNow Rest. Un ou plusieurs enregistrements de données de badgeage brutes (charge utile) peuvent être partagés et traités à l’aide de l’explorateur d’API REST. L’événement webhook pour les données de badgeage est chargé dans la table Événements du connecteur dans un ou plusieurs enregistrements JSON. Plusieurs enregistrements sont envoyés sous forme de tableau. Pour plus d'informations, consultez Analyse de la présence.

    Procédure

    1. Accédez à la Tout > Connecteurs du lieu de travail > Configurations du connecteur fournisseur.
    2. Sélectionnez Créer nouveau.

      Renseignez les champs du formulaire.

      Tableau 1. Formulaire Configuration du connecteur fournisseur
      Champ Description
      Nom Nom de la configuration du fournisseur.
      Configuration du connecteur Option permettant de rechercher et de sélectionner l’icône de la liste de recherche ( icône de la liste de recherche.) pour sélectionner Badgeage.

      Pour plus d'informations, consultez Configurer la configuration du connecteur pour les données de badgeage.

      Type de source Source à partir de laquelle les données de badgeage sont collectées et chargées dans la table de données de badgeage cible.

      Sélectionnez Webhook pour configurer l’événement webhook.

      Nom du paramètre du jeton

      Le nom du paramètre du jeton et la valeur du jeton sont une paire clé-valeur secrète, qui est utilisée pour authentifier l’appel d’API du système de badgeage du fournisseur vers l’application Connecteurs de lieu de travail . Les deux systèmes ont la valeur du nom du jeton. À l’aide du nom du jeton, l’application authentifie la demande d’API.

      Valeur du jeton La valeur du jeton correspond à la clé secrète utilisée par le fournisseur de badges lors de l’appel de l’événement API pour permettre au serveur d’authentifier la demande d’API.
      Actif Option permettant d’indiquer que la configuration du fournisseur est active.
      URL de rappel Option permettant de sélectionner l’icône URL de rappel (icône URL de rappel)pour verrouiller ou modifier l’URL de rappel.
      Actualisation automatique de l'emplacement Option permettant d’actualiser automatiquement les emplacements lorsque des espaces sont ajoutés ou lorsque certains espaces sont supprimés d’un emplacement sélectionné.

      La tâche planifiée d’actualisation des enregistrements de mappage de l’espace du fournisseur s’exécute quotidiennement et lit le champ Emplacement d’actualisation automatique dans la table Configuration du connecteur fournisseur. Cela lit tous les enregistrements des enregistrements de configuration du connecteur fournisseur et met à jour la table de mappage de l’espace du fournisseur avec les dernières données. Par exemple, si un nouvel étage ou un nouvel espace est ajouté à un emplacement, il est automatiquement ajouté à l’emplacement sélectionné.

      Mesures Option permettant de sélectionner l’enregistrement cible pour les mesures prises en charge. Sélectionnez Données d’événement.
    3. Sélectionnez Mettre à jour.
    4. Sélectionnez l’événement webhook nouvellement créé.

      Le bouton Générer l’URL de rappel est disponible pour générer une URL de rappel pour la demande d’API REST.

    5. En tant que fournisseur de badges, partagez les données de badgeage au format JSON en accédant à Tout > Services web du système > REST > Explorateur d'API Rest.
    6. Sur la page Explorateur d’API REST, sélectionnez les éléments suivants :
      • Espace de noms : dans la liste déroulante, sélectionnez sn_wsd_wc
      • Nom de l’API : Webhook du connecteur du lieu de travail
      • Version de l’API : v1
    7. Sur la page d’événement Webhook du connecteur du lieu de travail, indiquez les valeurs suivantes :
      • token_name : nom du paramètre de jeton utilisé à l’étape 2. La valeur du nom du jeton est utilisée par les fournisseurs de badges pour partager les données de badgeage (JSON) avec .Connecteurs de lieu de travail Les données brutes (charge utile ou données de badges) sont traitées et chargées dans la table Événements de connecteur.
      • ni.nolog.id : copiez l’ID système du webhook créé à l’étape 2 et collez-le. Sélectionnez l’icône de menu Actions supplémentaires ( Icône de menu Actions supplémentaires.) dans le volet.
      • token_value : valeur du jeton fournie à l’étape 2. La valeur du jeton correspond à la clé secrète utilisée par le fournisseur de badges lors de l’appel de l’événement API pour permettre au serveur d’authentifier la demande d’API.
      1. Dans le corps de la demande d’API, sélectionnez Brut et copiez les données de badgeage (charge utile) au format JSON.
        Ces données de badgeage sont collectées à partir de capteurs de badges.
      2. Sélectionnez Envoyer.
        Si le code de réponse est 200 OK et que le résultat de la réponse est Réussite, les données de badgeage sont chargées dans la table Événements du connecteur.
        • La table Événements du connecteur (sn_wsd_wc_connector_events) charge les données de badgeage partagées par les fournisseurs de badges. L’état des données de badgeage est Nouveau lorsqu’elles sont chargées par l’explorateur d’API REST.
        • Les enregistrements de données de fournisseur de webhooks de processus de tâche planifiée s’exécutent toutes les minutes pour charger les données de badgeage de la table Événements du connecteur (données avec l’état Nouveau) vers la table Données de participation des employés.
      La tâche planifiée utilise les données sources de l’événement Webhook pour transformer les données au format requis, puis les place dans la table de données de participation des employés cible.
      Remarque :
      Pour accéder aux Connecteurs de lieu de travail travaux planifiés, accédez à Tout > Définition du système > Travaux planifiés. Recherchez les connecteurs du lieu de travail dans la colonne Application. Deux travaux planifiés sont disponibles pour Connecteurs de lieu de travail.
      • Traiter les enregistrements de données de fournisseur : lit les données à partir des données de badgeage des fournisseurs (table source). Après avoir traité les données de badgeage, l’enregistrement les charge dans la table Données de participation des employés (table cible). Pour plus d'informations, consultez Configurer les données de table des badges.
      • Traiter les enregistrements de données de fournisseur de webhooks : lit les données à partir de la table Événements du connecteur. Traite les données d’événement webhook et les charge dans la table Données de participation des employés (table cible).
      • Les données sont chargées dans la table de données de participation des employés. L’état des données de badgeage dans la table Événements du connecteur bascule sur Traité.
      • À partir de la table Données de participation des employés, les données sont chargées dans la table Analyse de présence.
        Remarque :
        Les enregistrements de données de badgeage dans la table Événements du connecteur avec l’état Traité sont purgés au bout de deux jours à compter de la date de création ou de la date actuelle par la table Événements du connecteur [sn_wsd_wc_connector_events]. Les données à l’état Erreur sont purgées au bout de sept jours à compter de la date de création. Les données dans l’état Nouveau ne sont pas purgées.