webhook オートメーションを作成する

1. 必要に応じて、アクセストークン、パスワード、SSH キーなど、オートメーションで使用する機密性の高い文字列ごとに W&B シークレットを作成します。シークレットは Team Settings で定義します。
2. webhook を作成し、エンドポイントと認証情報を定義して、インテグレーションに必要なシークレットへのアクセス権を付与します。
3. オートメーションを作成し、監視するイベントと W&B が送信するペイロードを定義します。また、ペイロードで使用するシークレットへのアクセス権をオートメーションに付与します。

​

webhook を作成する

1. W&B にログインし、Team Settings ページに移動します。
2. Webhooks セクションで New webhook をクリックします。
3. webhook の名前を入力します。
4. webhook のエンドポイント URL を入力します。
5. webhook で Bearer token が必要な場合は、Access token にそのトークンを含むシークレットを設定します。webhook オートメーションの使用時、W&B は Authorization: Bearer HTTP ヘッダーにアクセストークンを設定します。また、${ACCESS_TOKEN} ペイロード変数でトークンにアクセスできます。W&B が webhook サービスに送信する POST リクエストの構造の詳細については、webhook のトラブルシューティングを参照してください。
6. webhook のペイロードにパスワードやその他の機密性の高い文字列が必要な場合は、Secret にその値を含むシークレットを設定します。webhook を使用するオートメーションを設定する際は、シークレット名の先頭に $ を付けることで、そのシークレットにペイロード変数としてアクセスできます。 webhook のアクセストークンがシークレットに保存されている場合は、次のステップ_も_完了して、そのシークレットをアクセストークンとして指定する必要があります。
7. W&B がエンドポイントに接続して認証できることを確認するには、次の手順を実行します。
   1. 必要に応じて、テスト用のペイロードを入力します。webhook がアクセスできるシークレットをペイロード内で参照するには、シークレット名の先頭に $ を付けます。このペイロードはテストにのみ使用され、保存されません。オートメーションのペイロードは、オートメーションを作成するときに設定します。シークレットとアクセストークンが POST リクエストのどこに含まれるかについては、webhook のトラブルシューティングを参照してください。
   2. Test をクリックします。W&B は、設定した認証情報を使用して webhook のエンドポイントへの接続を試みます。ペイロードを入力した場合は、そのペイロードも送信されます。
   テストが失敗した場合は、webhook の設定を確認してから再試行してください。必要に応じて、webhook のトラブルシューティングを参照してください。

​

オートメーションを作成する

​

オートメーションの表示と管理

​

ペイロードリファレンス

​

ペイロード変数

​

ペイロードの例

on:
repository_dispatch:
  types: BUILD_AND_DEPLOY

{
  "event_type": "BUILD_AND_DEPLOY",
  "client_payload":
  {
    "event_author": "${event_author}",
    "artifact_version": "${artifact_version}",
    "artifact_version_string": "${artifact_version_string}",
    "artifact_collection_name": "${artifact_collection_name}",
    "project_name": "${project_name}",
    "entity_name": "${entity_name}"
    }
}

${event_type} --> "LINK_ARTIFACT" or "ADD_ARTIFACT_ALIAS"
${event_author} --> "<wandb-user>"
${artifact_version} --> "wandb-artifact://_id/QXJ0aWZhY3Q6NTE3ODg5ODg3"
${artifact_version_string} --> "<entity>/model-registry/<registered_model_name>:<alias>"
${artifact_collection_name} --> "<registered_model_name>"
${project_name} --> "model-registry"
${entity_name} --> "<entity>"

{
"@type": "MessageCard",
"@context": "http://schema.org/extensions",
"summary": "New Notification",
"sections": [
  {
    "activityTitle": "Notification from WANDB",
    "text": "This is an example message sent via Teams webhook.",
    "facts": [
      {
        "name": "Author",
        "value": "${event_author}"
      },
      {
        "name": "Event Type",
        "value": "${event_type}"
      }
    ],
    "markdown": true
  }
]
}

{
    "text": "New alert from WANDB!",
"blocks": [
    {
            "type": "section",
        "text": {
            "type": "mrkdwn",
            "text": "Registry event: ${event_type}"
        }
    },
        {
            "type":"section",
            "text": {
            "type": "mrkdwn",
            "text": "New version: ${artifact_version_string}"
        }
        },
        {
        "type": "divider"
    },
        {
            "type": "section",
        "text": {
            "type": "mrkdwn",
            "text": "Author: ${event_author}"
        }
        }
    ]
}

​

webhook のトラブルシューティング

#!/bin/bash

# アクセストークンとシークレット
ACCESS_TOKEN="your_api_key"
SECRET="your_api_secret"

# webhook エンドポイントの URL
API_ENDPOINT="https://your.webhook.endpoint/path"

# 送信するデータ（例: JSON 形式）
PAYLOAD='{"key1": "value1", "key2": "value2"}'

# HMAC 署名を生成します。セキュリティのため、W&B は
# ペイロードと webhook に関連付けられた共有シークレットから
# HMAC（SHA-256）で計算した X-Wandb-Signature ヘッダーを含めます。
SIGNATURE=$(echo -n "$PAYLOAD" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $2}')

# cURL リクエストを実行します
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Wandb-Signature: $SIGNATURE" \
  -d "$PAYLOAD" "$API_ENDPOINT"