Richten Sie einen bidirektionalen Webhook für die GitHub-Spoke ein

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 3 Minuten Lesedauer

    • Konfigurieren Sie einen Webhook, um GitHub mit einer Rückruf-URL ServiceNow zu abonnieren.

    Vorbereitungen

    • IntegrationHub-Abonnement anfordern
    • GitHub-Spoke aktivieren
    • Erforderliche Rolle: admin

    Erstellen Sie ein Geheimnis für die GitHub-Spoke

    Erstellen Sie ein Geheimnis, das in die Webhook-URL GitHub eingebettet werden soll.

    Vorbereitungen

    Erforderliche Rolle: admin

    Prozedur

    1. Navigieren zu Alle > Systemdefinition > Skripts – Hintergrund.
    2. Geben Sie diesen Befehl in das Textfeld „Skript ausführen (JavaScript auf dem Server ausgeführt)“ ein:
      gs.info(GlideSecureRandomUtil.getSecureRandomString(16));
    3. Klicken Sie auf Skript ausführen.
    4. Kopieren Sie das generierte Geheimnis, und notieren Sie es zur späteren Verwendung.

    Webhook [ GitHub in ServiceNow] registrieren

    Registrieren Sie einen GitHub in ServiceNow [], um die App ServiceNow zu benachrichtigen, wenn bestimmte Ereignisse in GitHubauftreten.

    Vorbereitungen

    Erforderliche Rolle: admin

    Prozedur

    1. Navigieren zu Alle > GitHub-Webhooks > GitHub-Webhook-Registrierungen.
    2. Klicken Sie auf Neu.
    3. Füllen Sie die Felder des Formulars aus.
      Tabelle : 1. Formular „GitHub-Webhook-Registrierung“.
      Feld Beschreibung
      Name Eindeutiger Name zur Identifizierung des Datensatzes. Beispiel: GitHub-Webhook.
      Beschreibung Beschreibung des Datensatzes.
      Geheimer Schlüssel Geheimnis, das Sie mit dem Modul „Skripts – Hintergrund“ generiert haben.
      Pfad GitHub Webhook-Pfad Standardmäßig ist dies auf api/sn_github_spoke/github_webhook_callbacks/wh_entry festgelegt.
    4. Klicken Sie mit der rechten Maustaste in den Header Kopfzeile des Formulars, und wählen Sie Speichern aus.
    5. Klicken Sie auf Callback URL.
      Das System zeigt die Rückruf-URL und das Geheimnis des Webhooks an.
    6. Kopieren Sie die Webhook-Rückruf-URL und das Geheimnis, und notieren Sie sie.

    Ergebnisse

    Der Webhook GitHub ist in Ihrer Instanz ServiceNow ] registriert.

    Fügen Sie eine Rückruf-URL hinzu in GitHub

    Geben Sie die Webhook-Rückruf-URL im Account GitHub an, um einen Webhook zu erstellen.

    Vorbereitungen

    Erforderliche Rolle: admin

    Prozedur

    1. Melden Sie sich bei Ihrem GitHub-Konto an.
    2. Erstellen Sie in Ihrem Atlassian-Konto einen Webhook.
    3. Geben Sie die Webhook-Rückruf-URL unter Nutzlast-URL und das Geheimnis unter Geheimnisein.

      Siehe GitHub Entwickler In der -Dokumentation finden Sie Anweisungen zum Erstellen und Konfigurieren eines Webhooks.

      Hinweis:
      GitHub-Spoke unterstützt Anwendungs-/JSON-Nutzlast. Konfigurieren Sie den Webhook GitHub entsprechend. Siehe GitHub Entwickler In der -Dokumentation finden Sie Anweisungen zum Erstellen und Konfigurieren eines Webhooks.

    Ergebnisse

    Die Rückruf-URL wird im Account GitHub hinzugefügt. Sie können Weiterleitungsrichtlinien und Subflows entsprechend Ihren Anforderungen erstellen. Unter Passen Sie einen bidirektionalen -Webhook vom Typ ] an finden Sie Informationen zum Erstellen neuer Weiterleitungsrichtlinien und Subflows.

    Passen Sie den bidirektionalen Webhook in an GitHub-Spoke

    Erstellen Sie eine Webhook-Weiterleitungsrichtlinie und einen Subflow gemäß Ihren Anforderungen in GitHub-Spoke.

    Vorbereitungen

    Erforderliche Rolle: admin

    Warum und wann dieser Vorgang ausgeführt wird

    Die Standardweiterleitungsrichtlinie in den Modulen für GitHub-WebHook-Weiterleitungsrichtlinien löst den relevanten Subflow GitHub aus und benachrichtigt die App ServiceNow, wenn bestimmte Ereignisse in GitHubauftreten. Unter GitHub Spoke finden Sie Informationen zu den Feldern GitHub, die von der Standardweiterleitungsrichtlinie unterstützt werden, und zu den Ereignissen GitHub, die von den Subflows unterstützt werden. Um andere Felder in Ihrem anwenderdefinierten Subflow zu verwenden und die Bedingungen in der Weiterleitungsrichtlinie anzupassen, gehen Sie wie folgt vor.

    Prozedur

    1. Navigieren zu Alle > Flow Designer > Designer.
    2. Klicken Sie auf Subflows.
    3. Erstellen Sie eine Kopie des erforderlichen Subflows.
    4. Passen Sie den erforderlichen Subflow an Ihre Anforderungen an, und veröffentlichen Sie ihn.
      Unter Subflows erstellen finden Sie weitere Informationen zum Erstellen und Verwenden von Subflows, und GitHub Spoke finden Sie Informationen zu den Feldern GitHub, die von der Standardweiterleitungsrichtlinie unterstützt werden, und zu den Ereignissen GitHub, die von den Subflows unterstützt werden.
    5. Navigieren zu GitHub-Webhooks > WebHook-Weiterleitungsrichtlinien für GitHub.
    6. Klicken Sie auf Neu.
    7. Füllen Sie die Felder des Formulars aus.
      Tabelle : 2. Formular „Entscheidung“
      Feld Beschreibung
      Bezeichnung Eindeutige Bezeichnung zur Identifizierung der Weiterleitungsrichtlinie.
      Standardantwort Option zum Angeben, ob dies die Standardantwort ist. Die Standardantwort ist anwendbar, wenn die Bedingungen nicht erfüllt sind.
      1. Klicken Sie auf das Suchsymbol.
      2. Wählen Sie den gewünschten Subflow aus der Liste Dokument: aus.
        Hinweis:
        Stellen Sie sicher, dass der TabellennameFlow [sys_hub_flow] lautet.
      Bedingung Bedingungen, die erfüllt werden müssen, wenn die erforderlichen Ereignisse in GitHubauftreten. Informationen zu den unterstützten Feldern finden Sie unter GitHub Spoke.
      Antwort Subflow, der ausgelöst werden muss, wenn die angegebenen Bedingungen erfüllt sind.
    8. Klicken Sie auf Absenden.
      Hinweis:
      Diese Weiterleitungsrichtlinien werden in den Entscheidungstabellen gespeichert. Benutzer werden davor gewarnt, Daten in diesen Tabellen direkt zu aktualisieren oder zu ändern.

    Ergebnisse

    Weiterleitungsrichtlinie und Subflow werden erstellt.