トークンを使用して DevOps 変更速度管理に受信イベントを送信するための Webhook の作成
トークンベースの認証を使用して、受信イベントを DevOps 変更速度管理に送信するには、Webhook を作成する必要があります。
受信イベントを ServiceNow インスタンスに送信するには、次の API エンドポイント構造を使用する必要があります。
<instance_url>/api/sn_devops/v2/devops/tool/{capability}?toolId=<toolId>ツール ID、インスタンス URL などの詳細をコピーするには、ツールレコードから [ 手動で構成] を選択するか、ツールのオンボーディング時に構成ステップで [構成] を選択します。その後、適切なフィールドで [コピー] を選択して、値をクリップボードにコピーできます。フィールドのラベルは [コピー済み] に変わりますが、何度でもコピーできます。次の画像は、DevOps 変更速度管理の GitHub ツールの値をコピーできるページを示しています。
トークン認証では、エンドポイントがセキュリティ保護されているため、認証ヘッダーまたはクエリパラメーターの一部としてトークンを渡す必要があります。次のいずれかの方法を使用できます。
- ヘッダー名:認証ヘッダー値:sn_devops の形式を使用して、トークンをヘッダーとして渡します。DevOpsToken <ToolId>:<Token>。ここで、<ToolId> はツールの ID で、<Token> は [ツールレコード] ページからコピーされた認証トークンです。
- トークンを URL のクエリパラメーターとして渡します: <instance_url>/api/sn_devops/v2/devops/tool/{capability}?toolId=<toolId>&ni.nolog.token=<Token> ここで、<ToolId> はツールの ID、[<Token> は [ツールレコード] ページからコピーされた認証トークンです。
ベーシック認証の場合は、 V1 エンドポイント https://user:password@<instance_url>/api/sn_devops/v1/devops/tool/{capability}?toolId=<toolId> を使用できます。ユーザーとパスワードを ServiceNow 認証情報に置き換えてください。
カスタムツールまたは別の認証方法がある場合は、独自の認証ロジックを実装できます。たとえば、ハンドラークラスに authenticateToken 関数を実装できます。関数はトークンを検証し、適切な認証を確認する必要があります。独自の認証ロジックを実装するには、ServiceNow で admin ロールが必要です。