Configurer un événement de webhook

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 4 minutes de lecture

    • Configurez un événement d’API Webhook dans la table Configuration du fournisseur pour permettre aux fournisseurs de badges de partager les données de badges collectées à partir des tables de badges à l’aide de l’événement Webhook.

    Avant de commencer

    Rôle requis : admin

    Pourquoi et quand exécuter cette tâche

    Les données relatives aux badges (JSON) sont traitées à l’aide de l’explorateur d’API ServiceNow Rest. Un ou plusieurs enregistrements de données de badges bruts (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 Tous > Connecteurs du lieu de travail > Configurations des fournisseurs.
    2. Sélectionnez Créer nouveau.

      Renseignez les champs du formulaire.

      Tableau 1. Formulaire Configuration du fournisseur
      Champ Description
      Nom Nom de la configuration du fournisseur.
      Type de source Source à partir de laquelle les données de badgeage sont collectées et chargées dans la table de présence des employés cible.

      Sélectionnez Webhook pour configurer l’événement webhook.
      Nom du paramètre du jeton

      Le nom du paramètre de 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 badges du fournisseur à 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 est la clé secrète utilisée par le fournisseur de badges lors de l’appel de l’événement d’API pour permettre au serveur d’authentifier la demande d’API.
      Actif Option permettant d’indiquer que la configuration du fournisseur est Active.
      Configuration du connecteur Option permettant de rechercher et de sélectionner l’icône de liste de recherche ( icône de liste de recherche.) pour sélectionner l’écusson.

      Pour plus d'informations, consultez Configurer un connecteur de spoke.
      URL de rappel Option permettant de sélectionner l’icône de l’URL de rappel ( icône URL de rappel.)pour verrouiller ou modifier l’URL de rappel.
    3. Sélectionnez Mettre à jour.
    4. Sélectionnez l’événement de 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.

      Configuration du fournisseur affichant l’événement webhook avec le bouton Générer l’URL de rappel.

    5. En tant que fournisseur de badges, partagez les données de badges au format JSON en accédant à Tous > Services web du système > REST > Explorateur d'API Rest.
    6. Dans 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 de webhook du connecteur du lieu de travail, fournissez 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 badges (JSON) avec Connecteurs de lieu de travail. Les données brutes (données de charge utile ou de badge) sont traitées et chargées dans la table Événements du connecteur.
      • ni.nolog.id : copiez l’ID système du webhook créé à l’étape 2 et collez-le. Sélectionnez l’icône du menu Actions supplémentaires ( icône du menu Actions supplémentaires.)dans le volet.
      • token_value : valeur de jeton fournie à l’étape 2. La valeur du jeton est la clé secrète utilisée par le fournisseur de badges lors de l’appel de l’événement d’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 sur les badges sont collectées à partir des capteurs de badges.
      2. Sélectionnez Envoyer.
        Si le code de réponse est OK 200 et que le résultat de la réponse est Réussite, les données relatives aux badges 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 défini sur Nouveau lorsqu’elles sont chargées par l’explorateur d’API REST.
        • Le processus de tâche planifié des enregistrements de données du fournisseur de webhook s’exécute toutes les minutes pour charger les données de badges de la table Événements du connecteur (données avec l’état Nouveau) dans la table Données de présence 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 placer dans la table de données de présence des employés cible.
      Remarque :
      Pour accéder aux Connecteurs de lieu de travail tâches planifiées, accédez à Tous > Définition du système > Travaux planifiés. Recherchez des connecteurs de lieu de travail dans la colonne Application. Deux tâches planifiées 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 du fournisseur (table source). Après avoir traité les données relatives aux badges, l’enregistrement les charge dans la table Données de présence des employés (table cible). Pour plus d'informations, consultez Configurer les données de la table des badges.
      • Traiter les enregistrements de données du 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 présence des employés (table cible).
      • Les données sont chargées dans la table Données de présence des employés. L’état des données de badgeage dans la table Événements du connecteur passe à Traité.
      • Les données sont chargées dans la table Analyse de présence des employés à partir de la table Données de présence des employés.
        Remarque :
        Les enregistrements de données de badgeage dans la table Événements du connecteur dont l’état est 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 après sept jours à compter de la date de création. Les données à l’état Nouveau ne sont pas purgées.