Webhook 자동화 생성하기

1. 필요한 경우, 엑세스 토큰, 비밀번호 또는 SSH 키와 같이 자동화에 필요한 각 민감한 문자열에 대해 W&B secret을 생성합니다. Secrets는 Team Settings에서 정의됩니다.
2. 엔드포인트 및 인증 세부 정보를 정의하고 인테그레이션에 필요한 secrets에 대한 엑세스 권한을 부여하기 위해 webhook을 생성합니다.
3. 모니터링할 event와 W&B가 보낼 페이로드를 정의하기 위해 automation을 생성합니다. 페이로드에 필요한 secrets에 대한 엑세스 권한을 자동화에 부여합니다.

​

Create a webhook

1. W&B에 로그인하고 Team Settings 페이지로 이동합니다.
2. Webhooks 섹션에서 New webhook을 클릭합니다.
3. webhook의 이름을 입력합니다.
4. webhook의 엔드포인트 URL을 입력합니다.
5. webhook에 Bearer 토큰이 필요한 경우, Access token을 해당 토큰이 포함된 secret으로 설정합니다. webhook 자동화를 사용할 때 W&B는 Authorization: Bearer HTTP 헤더를 엑세스 토큰으로 설정하며, ${ACCESS_TOKEN} payload variable을 통해 토큰에 엑세스할 수 있습니다. W&B가 webhook 서비스로 보내는 POST 요청의 구조에 대한 자세한 내용은 Troubleshoot your webhook에서 확인하세요.
6. webhook의 페이로드에 비밀번호나 기타 민감한 문자열이 필요한 경우, Secret을 해당 문자열이 포함된 secret으로 설정합니다. 해당 webhook을 사용하는 자동화를 구성할 때, 이름 앞에 $를 붙여 payload variable로서 secret에 엑세스할 수 있습니다. webhook의 엑세스 토큰이 secret에 저장된 경우, 해당 secret을 엑세스 토큰으로 지정하기 위해 다음 단계도 반드시 완료해야 합니다.
7. W&B가 엔드포인트에 연결 및 인증할 수 있는지 확인하려면:
   1. 선택적으로, 테스트할 페이로드를 제공합니다. 페이로드 내에서 webhook이 엑세스 권한을 가진 secret을 참조하려면 이름 앞에 $를 붙입니다. 이 페이로드는 테스트용으로만 사용되며 저장되지 않습니다. 자동화의 페이로드는 automation을 생성할 때 구성합니다. POST 요청에서 secret과 엑세스 토큰이 지정되는 위치를 보려면 Troubleshoot your webhook을 참조하세요.
   2. Test를 클릭합니다. W&B는 구성된 자격 증명을 사용하여 webhook의 엔드포인트 연결을 시도합니다. 페이로드를 제공한 경우 W&B가 이를 전송합니다.
   테스트가 성공하지 못하면 webhook 설정을 확인하고 다시 시도하세요. 필요한 경우 Troubleshoot your webhook을 참조하세요.

​

Create an automation

​

View and manage automations

​

Payload reference

​

Payload variables

​

Payload examples

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" 또는 "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}"
        }
        }
    ]
}

​

Troubleshoot your webhook

#!/bin/bash

# 엑세스 토큰 및 secret
ACCESS_TOKEN="your_api_key"
SECRET="your_api_secret"

# 전송하려는 데이터 (예: JSON 형식)
PAYLOAD='{"key1": "value1", "key2": "value2"}'

# HMAC 서명 생성
# 보안을 위해, Wandb는 페이로드와 webhook에 연결된 
# 공유 비밀 키로부터 HMAC SHA-256 알고리즘을 사용하여 
# 계산된 X-Wandb-Signature를 헤더에 포함합니다.
SIGNATURE=$(echo -n "$PAYLOAD" | openssl dgst \
-sha256 -hmac "$SECRET" -binary | base64)

# cURL 요청 실행
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Wandb-Signature: $SIGNATURE" \
  -d "$PAYLOAD" API_ENDPOINT