Webhooks konfigurieren und testen

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

    • Konfigurieren Sie Webhooks manuell in Azure DevOps, und testen Sie sie.

    Konfigurieren Sie Webhooks manuell in Azure DevOps .

    Konfigurieren Sie Webhooks in Azure DevOpsDevOps Change-Geschwindigkeit, um Synchronisierungsbenachrichtigungen an die Anwendung [] zu senden.

    Vorbereitungen

    Erforderliche Rolle: sn_devops.admin oder sn_devops.tool_owner in DevOps Change-Geschwindigkeit, Azure DevOps admin

    Warum und wann dieser Vorgang ausgeführt wird

    Sie können die manuelle Konfiguration auch über den Azure DevOps Tooldatensatz in DevOps Change-Geschwindigkeitaufrufen .

    Prozedur

    1. Öffnen Sie in Azure DevOpsdas Projekt, für das Sie Webhooks konfigurieren.
    2. Navigieren zu Einstellungen > Service-Hooks und erstellen Sie ein NEUES SERVICE-HOOKS-ABONNEMENT in Azure DevOps.
    3. Wählen Sie in DevOps Change-Geschwindigkeitdie Option Manuell konfigurieren, wenn Sie die Toolinstanz zum Senden von Daten konfigurieren.
      Azure DevOps-Konfigurationstool
    4. Kopieren Sie in DevOps Change-Geschwindigkeitdas Feld Webhook-URL aus den ServiceNow-Instanzverbindungsdetails für Azure DevOps.
      Hinweis:
      Wählen Sie im entsprechenden Feld Kopieren aus, um den Wert in die Zwischenablage zu kopieren. Die Feldbezeichnung ändert sich in Kopiert, Sie können jedoch mehrmals kopieren.
      Azure DevOps konfiguriert Webhooks manuell
    5. Ändern Sie die kopierte Webhook-URL so, dass sie Ihre Tooldetails widerspiegelt, und fügen Sie die URL in Azure DevOpsein.

      Beispiel:

      https://myinstance.service-now.com/api/sn_devops/v2/devops/tool/{code | planen | Artefakt | Orchestration | -Test | softwarequality }?toolId=23410545938c71d0db5bfe686cba1036&projectId=<project_sys_id>

      1. Wählen Sie eine der Toolfähigkeiten {Code | | aus planen | Artefakt | Orchestration | -Test | Softwarequalität } entsprechend Ihrem Tool.
        Beispiel:

        https://myinstance.service-now.com/api/sn_devops/v2/devops/tool/orchestration?toolId=23410545938c71d0db5bfe686cba1036&projectId=<project_sys_id>

      2. Ersetzen<project_sys_id> mit Ihrer Projekt-ID [ Azure DevOps in ServiceNow (Spalte „native_id“ in der Tabelle „sn_devops_project“).
      3. Kopieren Sie die geänderte URL in das URL -Feld des Abonnements NEW SERVICE HOOKS in Azure DevOps.
    6. Kopieren Sie in DevOps Change-Geschwindigkeitdas Feld Geheimes Token aus den Verbindungsdetails der ServiceNow-Instanz für Azure DevOps.
    7. Fügen Sie in Azure DevOpsim Feld Header des NEUEN SERVICE-HOOKS-ABONNEMENTS das kopierte Geheime Token im richtigen Format ein.
      1. Dieses Format für das Feld Azure DevOps „HTTP-Header“ verwenden:
        “Token:<tokenValue> “
      2. Ersetzen<tokenValue> , mit dem geheimen Token aus den Verbindungsdetails der ServiceNow-Instanz für Azure DevOps .
      Tabelle : 1. Feldwerte kopieren
      Aus dem Feld DevOps Change-Geschwindigkeit Feld „An GitHub
      Webhook-URL (geändert) URL
      Geheimer Token

      HTTP-Header

      Im Format:

      Token:<tokenValue>
      Azure DevOps konfiguriert Webhooks manuell

    Testen Sie Webhooks in Azure DevOps

    Sie können für jedes Projekt direkt in Azure DevOps manuell testen, ob die Webhooks richtig konfiguriert sind.

    Vorbereitungen

    Erforderliche Rolle: Azure DevOps Administratorrechte

    Prozedur

    1. Navigieren Sie zu Azure DevOps, und wählen Sie das Projekt aus, für das Sie Webhooks testen möchten.
    2. Navigieren zu Projekteinstellungen > Service-Hooksan.
      Für jedes Projekt erstellt DevOps Change-Geschwindigkeit Webhooks für diese Ereignisse:
      • Build abgeschlossen
      • Code veröffentlicht
      • Release erstellt
      • Release-Bereitstellung abgeschlossen
      • Status der Ausführungsphase geändert
      • Arbeitselement erstellt
      • Arbeitselement gelöscht
      • Arbeitselement wiederhergestellt
      • Arbeitselement aktualisiert
    3. Wählen Sie einen Webhook und dann Bearbeitenaus.
    4. Wählen Sie Weiter aus, um die URL und Authentifizierungsdetails anzuzeigen.

      Details des konfigurierten Webhooks

    5. Um den Webhook zu testen, wählen Sie Testaus.

      • Wenn der Webhook ordnungsgemäß konfiguriert ist, erhalten Sie die Meldung Erfolg.

        Erfolgsmeldung, wenn der Webhook ordnungsgemäß konfiguriert ist.

      • Wenn der Webhook falsch konfiguriert ist, erhalten Sie die Meldung Fehlgeschlagen.

        Fehlermeldung, wenn der Webhook ordnungsgemäß konfiguriert ist.

        Um einen Webhook zu beheben, können Sie die folgenden Optionen ausprobieren:
        • Konfigurieren Sie die Webhooks neu, indem Sie auf der Seite des Projektdatensatzes in DevOps Change-Geschwindigkeitdie Option Konfigurieren auswählen. Dadurch werden alle vorhandenen Webhooks für das Projekt neu konfiguriert.

        • Überprüfen Sie, ob toolId und projectId im URL -Feld korrekt sind. Sie finden die richtigen Werte auf der Tooldatensatzseite in DevOps Change-Geschwindigkeit.

          „toolId“ und „projectId“ in der URL.

        • Wenn Sie die Anmeldeinformationen des Integrationsbenutzers für die Authentifizierung verwenden, überprüfen Sie, ob die Anmeldeinformationen in den Feldern Anwendername und Passwort für Standardauthentifizierung korrekt sind.

          Standardauthentifizierungsfelder im Webhook

        • Wenn Sie das geheime Token für die Authentifizierung verwenden, wird der Tokenwert im Feld Passwort für Standardauthentifizierung maskiert. Sie können das Token in diesem Feld ersetzen.

          Token im Webhook