Webhook の構成とテスト
Azure DevOps で Webhook を手動で構成し、テストします。
Webhook をAzure DevOps で手動で構成
DevOps 変更速度管理 アプリケーションに同期通知を送信するように Azure DevOps で Webhook を構成します。
始める前に
必要なロール: sn_devops.admin または sn_devops.tool_owner ( DevOps 変更速度管理、 Azure DevOps admin)
このタスクについて
DevOps 変更速度管理 のAzure DevOpsツールレコードから手動構成にアクセスすることもできます。
手順
- Azure DevOps で、Webhook を構成するプロジェクトを開きます。
- 移動先 設定 > サービスフック Azure DevOpsで新しいサービスフックサブスクリプションを作成します。
-
DevOps 変更速度管理 で、データを送信するようにツールインスタンスを設定するときに [手動で構成]を選択します。
-
DevOps 変更速度管理で、Azure DevOpsの ServiceNow インスタンス接続の詳細から [Webhook URL] フィールドをコピーします。
注:適切なフィールドで [コピー] を選択して、値をクリップボードにコピーします。フィールドのラベルは [コピー済み (Copied)] に変わりますが、何度でもコピーできます。
-
コピーした 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>
-
使用するツールに合わせて、ツール機能 {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>
- <project_sys_id> をServiceNow内のAzure DevOpsプロジェクト ID (sn_devops_projectテーブルの native_id 列) に置き換えます。
- 変更した URL を Azure DevOps の NEW SERVICE HOOKS SUBSCRIPTION の URL フィールドにコピーします。
-
使用するツールに合わせて、ツール機能 {code | plan | artifact | orchestration | test | softwarequality} を 1 つ選択します。
- DevOps 変更速度管理 で、Azure DevOps の ServiceNow インスタンス接続の詳細から [シークレットトークン] フィールドをコピーします。
-
[ Azure DevOps] の [NEW SERVICE HOOKS SUBSCRIPTION] の [ヘッダー (Header)] フィールドに、コピーしたシークレットトークンを正しい形式で貼り付けます。
-
Azure DevOps [HTTP ヘッダー (HTTP headers)] フィールドには次の形式を使用します。
”トークン : <tokenValue>"
- <tokenValue> を、Azure DevOps の ServiceNow インスタンス接続の詳細からコピーしたシークレットトークンに置き換えます。
表 : 1. フィールド値をコピー 変換元 DevOps 変更速度管理 フィールド 変換先 Azure DevOps フィールド Webhook URL (変更済み) URL シークレットトークン HTTP ヘッダー
次の形式を使用します。
トークン : <tokenValue>
-
Azure DevOps [HTTP ヘッダー (HTTP headers)] フィールドには次の形式を使用します。
Azure DevOpsでの Webhook のテスト
Webhook が正しく構成されているかどうかは、プロジェクトごとに Azure DevOps から直接手動でテストできます。
始める前に
必要なロール:Azure DevOpsadmin 権限
手順
- [ Azure DevOps ] に移動し、Webhook をテストするプロジェクトを選択します。
-
移動先 プロジェクト設定 > サービスフック.
プロジェクトごとに、 DevOps 変更速度管理 は次のイベントの Webhook を作成します。
- ビルド完了
- プッシュされたコード
- リリース作成
- リリース展開完了
- 実行ステージのステータスが変更されました
- 作成された作業アイテム
- 作業アイテムが削除されました
- 復元された作業アイテム
- 作業アイテムが更新されました
- Webhook を選択し、 [ 編集] を選択します。
-
次へ を選択し、URL と認証の詳細を確認します。
-
Webhook をテストするには、 [ テスト] を選択します。
-
Webhook が正しく構成されている場合は、「 成功」 というメッセージが表示されます。
-
Webhook が正しく構成されていない場合は、「 失敗 」というメッセージが表示されます。
Webhook を修正するには、次のオプションを試すことができます。- DevOps 変更速度管理 のプロジェクトレコードページから [構成] を選択して、Webhook を再構成します。これにより、プロジェクトの既存のすべての Webhook が再構成されます。
[URL] フィールドのtoolIdとprojectIdが正しいかどうかを確認します。正しい値は、DevOps 変更速度管理のツールレコードページで確認できます。
認証に統合ユーザー認証情報を使用している場合は、[ ベーシック認証 のユーザー名とパスワード] フィールドで認証情報が正しいかどうかを確認します。
認証にシークレットトークンを使用している場合、トークン値は [ベーシック認証パスワード ] フィールドでマスクされます。このフィールドでトークンを置き換えることができます。
-