Configurer un webhook bidirectionnel pour GitHubSpoke

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 3 minutes de lecture
  • Configurez le webhook auquel GitHub vous abonner avec une ServiceNow URL de rappel.

    Avant de commencer

    • Demander Hub d'intégration un abonnement
    • Activer le GitHubSpoke
    • Rôle requis : admin

    Créer un secret pour le GitHubSpoke

    Créer un secret à incorporer dans l’URL Webhook GitHub .

    Avant de commencer

    Rôle requis : admin

    Procédure

    1. Accédez à la Tout > Définition du système > Scripts - Arrière-plan.
    2. Entrez cette commande dans le champ de texte Exécuter le script (JavaScript exécuté sur le serveur) :
      gs.info(GlideSecureRandomUtil.getSecureRandomString(16)) ;
    3. Cliquez sur Exécuter le script.
    4. Copiez et enregistrez la clé secrète générée pour une utilisation ultérieure.

    Inscrire un GitHub webhook dans ServiceNow

    Enregistrez un GitHub dans ServiceNow pour avertir l’application ServiceNow lorsque certains événements se produisent dans .GitHub

    Avant de commencer

    Rôle requis : admin

    Procédure

    1. Accédez à la Tout > GitHub Webhooks > Registres Webhook GitHub.
    2. Cliquez sur Nouveau.
    3. Renseignez les champs du formulaire.
      Tableau 1. Formulaire Registre de webhook GitHub
      Champ Description
      Nom Nom unique permettant d’identifier l’enregistrement. Par exemple, le webhook GitHub.
      Description Description de l’enregistrement.
      Clé secrète Secret que vous avez généré à l’aide du module Scripts - Arrière-plan.
      Chemin d'accès GitHub Chemin d’accès du webhook. Par défaut, il est défini sur api/sn_github_spoke/github_webhook_callbacks/wh_entry.
    4. Cliquez avec le bouton droit sur l'en-tête du formulaire, puis cliquez sur Enregistrer.
    5. Cliquez sur URL de rappel.
      Le système affiche l’URL de rappel Webhook.
    6. Copiez et enregistrez l’URL de rappel Webhook.

    Résultats

    Le GitHub webhook est inscrit dans votre ServiceNow instance.

    Ajouter une URL de rappel dans GitHub

    Fournissez une URL de rappel Webhook dans le GitHub compte pour créer un webhook.

    Avant de commencer

    Rôle requis : admin

    Procédure

    1. Connectez-vous à votre compte GitHub.
    2. Créez un webhook dans votre compte Atlassian.
    3. Entrez l’URL de rappel webhook dans l’URL de la charge utile et le secret dans le secret.

      Voir le GitHub Développeur documentation pour obtenir des instructions sur la création et la configuration d’un webhook.

      Remarque :
      GitHubSpoke Prend en charge la charge utile d’application/JSON. Configurez le webhook en GitHub conséquence. Voir le GitHub Développeur documentation pour obtenir des instructions sur la création et la configuration d’un webhook.

    Résultats

    L’URL de rappel est ajoutée au GitHub compte. Vous pouvez créer des politiques d’acheminement et des flux secondaires selon vos besoins. Consultez Personnaliser un webhook bidirectionnel pour plus d’informations sur la création de nouvelles politiques d’acheminement et de nouveaux flux secondaires.

    Personnaliser le webhook bidirectionnel dans GitHubSpoke

    Créez une politique d’acheminement de webhook et un flux secondaire selon vos besoins dans le GitHubSpoke .

    Avant de commencer

    Rôle requis : admin

    Pourquoi et quand exécuter cette tâche

    La politique d’acheminement par défaut dans les modules Politiques d’acheminement de webhook GitHub déclenche le flux secondaire pertinent GitHub et informe l’application ServiceNow lorsque certains événements se produisent dans GitHub. Consultez GitHub Parlé pour plus d’informations sur les GitHub champs que la politique d’acheminement par défaut prend en charge et les GitHub événements que les flux secondaires prennent en charge. Pour utiliser d’autres champs dans votre flux secondaire personnalisé et personnaliser les conditions de la politique d’acheminement, effectuez les étapes suivantes.

    Procédure

    1. Accédez à la Tout > Concepteur de flux > Concepteur.
    2. Cliquez sur Flux secondaires.
    3. Créez une copie du flux secondaire requis.
    4. Personnalisez le flux secondaire requis selon vos besoins et publiez-le.
      Reportez-vous à la section Création de flux secondaires pour en savoir plus sur la création et l’utilisation de flux secondaires, ainsi GitHub Parlé que sur les GitHub champs pris en charge par la politique d’acheminement par défaut et les GitHub événements pris en charge par les flux secondaires.
    5. Accédez à la GitHub Webhooks > Politiques d’acheminement de WebHook GitHub.
    6. Cliquez sur Nouveau.
    7. Renseignez les champs du formulaire.
      Tableau 2. Formulaire Décision
      Champ Description
      Étiquette Étiquette unique pour identifier la politique d’acheminement.
      Réponse par défaut Option permettant de spécifier s’il s’agit de la réponse par défaut. La réponse par défaut s’applique lorsque les conditions ne sont pas remplies.
      1. Cliquez sur l’icône de recherche.
      2. Sélectionnez le flux secondaire requis dans la liste Document : .
        Remarque :
        Assurez-vous que le nom de la table est Flux [sys_hub_flow].
      Condition Conditions à remplir lorsque les événements requis se produisent dans GitHub. Consultez GitHub Parlé pour plus d’informations sur les champs pris en charge.
      Réponse Flux secondaire qui doit être déclenché lorsque les conditions spécifiées sont remplies.
    8. Cliquez sur Envoyer.
      Remarque :
      Ces politiques d’acheminement sont enregistrées dans les tables de décision. Les utilisateurs sont mis en garde contre la mise à jour ou la modification directe des données dans ces tables.

    Résultats

    La politique d’acheminement et le flux secondaire sont créés.