Webhook の構成とテスト

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：4分

    • Azure DevOps で Webhook を手動で構成し、テストします。

    Azure DevOps での Webhook の手動構成

    同期通知を DevOps チェンジベロシティ アプリケーションに送信するように Azure DevOps で Webhook を構成します。

    始める前に

    必要なロール: DevOps チェンジベロシティ sn_devops.admin または sn_devops.tool_owner、 Azure DevOps admin

    このタスクについて

    DevOps チェンジベロシティ のAzure DevOpsツールレコードから手動構成にアクセスすることもできます。

    手順

    1. Azure DevOps で、Webhook を構成するプロジェクトを開きます。
    2. 移動先 設定 > サービスフック Azure DevOps で NEW SERVICE HOOKS SUBSCRIPTION を作成します。
    3. DevOps チェンジベロシティ で、データを送信するようにツールインスタンスを設定するときに [Configure manually] (手動で構成) を選択します。
      Azure DevOps 構成ツール
    4. DevOps チェンジベロシティで、Azure DevOpsの ServiceNow インスタンス接続の詳細から [Webhook URL] フィールドをコピーします。
      注:
      適切なフィールドで [ コピー ] を選択して、値をクリップボードにコピーします。フィールドのラベルは [コピー済み] に変わりますが、何度でもコピーできます。
      Azure DevOps による Webhook の手動構成
    5. コピーした Webhook URL を変更してツールの詳細を反映させ、 Azure DevOps に貼り付けます。

      例：

      https://myinstance.service-now.com/api/sn_devops/v2/devops/tool/{code | plan | artifact | orchestration | test | softwarequality }?toolId=23410545938c71d0db5bfe686cba1036&projectId=<project_sys_id>

      1. 使用するツールに合わせて、ツール機能 {code | plan | artifact | orchestration | test | softwarequality} を 1 つ選択します。
        例：

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

      2. <project_sys_id> を<c2/>内の<c1/>プロジェクト ID (sn_devops_projectテーブルの native_id 列) に置き換えます。Azure DevOpsServiceNow
      3. 変更した URL を Azure DevOps の NEW SERVICE HOOKS SUBSCRIPTION の URL フィールドにコピーします。
    6. DevOps チェンジベロシティで、Azure DevOps の ServiceNow インスタンス接続の詳細から [シークレットトークン] フィールドをコピーします。
    7. [ Azure DevOps] の [NEW SERVICE HOOKS SUBSCRIPTION] の [ ヘッダー ] フィールドに、コピーした Secret トークン を正しい形式で貼り付けます。
      1. Azure DevOps HTTP ヘッダーフィールドには次の形式を使用します。
        "token : <tokenValue>"
      2. <tokenValue> を、<c2/> の ServiceNow インスタンス接続の詳細からコピーしたシークレットトークンに置き換えます。Azure DevOps
      表 : 1. フィールド値をコピー
      DevOps チェンジベロシティフィールドから 宛先 GitHub フィールド
      Webhook URL (変更済み) URL
      シークレットトークン

      HTTP ヘッダー

      次の形式を使用します。

      トークン : <tokenValue>
      Azure DevOps による Webhook の手動構成

    での Webhook のテスト Azure DevOps

    Webhook が正しく構成されているかどうかは、プロジェクトごとに Azure DevOps から直接手動でテストできます。

    始める前に

    必要なロール: Azure DevOps admin 権限

    手順

    1. [ Azure DevOps ] に移動し、Webhook をテストするプロジェクトを選択します。
    2. 移動先 プロジェクト設定 > サービスフック.
      プロジェクトごとに、 DevOps チェンジベロシティ は次のイベントの Webhook を作成します。
      • ビルド完了
      • プッシュされたコード
      • リリースが作成されました
      • リリース展開が完了しました
      • 実行ステージのステータスが変更されました
      • 作業アイテムが作成されました
      • 作業アイテムが削除されました
      • 復元された作業アイテム
      • 作業アイテムが更新されました
    3. Webhook を選択し、 [ 編集] を選択します。
    4. [ 次へ ] を選択して、URL と認証の詳細を表示します。

      構成された Webhook の詳細。

    5. Webhook をテストするには、 [ テスト] を選択します。

      • Webhook が正しく構成されている場合は、 成功 というメッセージが表示されます。

        Webhook が正しく構成された場合の成功メッセージ。

      • Webhook が正しく構成されていない場合は、 Failed (失敗 ) メッセージが表示されます。

        Webhook が正しく構成されている場合のエラーメッセージ。

        Webhook を修正するには、次のオプションを試すことができます。
        • DevOps チェンジベロシティ のプロジェクトレコードページから [構成] を選択して、Webhook を再構成します。これにより、プロジェクトの既存のすべての Webhook が再構成されます。

        • [URL] フィールドのtoolIdとprojectIdが正しいかどうかを確認します。DevOps チェンジベロシティのツールレコードページで正しい値を確認できます。

          toolId と projectId。

        • 認証に統合ユーザー認証情報を使用している場合は、[ ベーシック認証 のユーザー名とパスワード] フィールドで認証情報が正しいかどうかを確認します。

          Webhook の基本認証フィールド。

        • 認証にシークレットトークンを使用している場合、トークン値は [ベーシック認証パスワード ] フィールドでマスクされます。このフィールドでトークンを置き換えることができます。

          Webhook のトークン。