Créer une automatisation webhook

1. Si nécessaire, créez un secret W&B pour chaque chaîne sensible requise par l’automatisation, comme un jeton d’accès, un mot de passe ou une clé SSH. Les secrets se définissent dans vos paramètres de l’équipe.
2. Créez un webhook pour définir le point de terminaison et les informations d’autorisation, puis accordez à l’intégration l’accès aux secrets dont elle a besoin.
3. Créez l’automatisation pour définir l’événement à surveiller et la charge utile envoyée par W&B. Accordez à l’automatisation l’accès aux secrets nécessaires à la charge utile.

​

Créer un webhook

1. Connectez-vous à W&B et accédez à la page paramètres de l’équipe.
2. Dans la section Webhooks, cliquez sur New webhook.
3. Saisissez un nom pour le webhook.
4. Saisissez l’URL du point de terminaison du webhook.
5. Si le webhook requiert un jeton Bearer, définissez Access token sur le secret qui le contient. Lorsque l’automatisation webhook est utilisée, W&B renseigne l’en-tête HTTP Authorization: Bearer avec le jeton d’accès, et vous pouvez accéder au jeton via la variable de charge utile ${ACCESS_TOKEN}. Pour plus d’informations sur la structure de la requête POST que W&B envoie au service du webhook, consultez Dépanner votre webhook.
6. Si le webhook requiert un mot de passe ou une autre chaîne de caractères sensible dans sa charge utile, définissez Secret sur le secret qui la contient. Lorsque vous configurez l’automatisation qui utilise le webhook, vous pouvez accéder au secret en tant que variable de charge utile en préfixant son nom par $. Si le jeton d’accès du webhook est stocké dans un secret, vous devez également effectuer l’étape suivante pour définir ce secret comme jeton d’accès.
7. Pour vérifier que W&B peut se connecter et s’authentifier auprès du point de terminaison :
   1. Facultativement, fournissez une charge utile de test. Pour faire référence dans la charge utile à un secret auquel le webhook a accès, préfixez son nom par $. W&B utilise cette charge utile uniquement pour le test et ne l’enregistre pas. La charge utile d’une automatisation se configure lorsque vous créez l’automatisation. Pour plus d’informations sur l’emplacement du secret et du jeton d’accès dans la requête POST, consultez Dépanner votre webhook.
   2. Cliquez sur Test. W&B tente de se connecter au point de terminaison du webhook à l’aide des identifiants d’authentification que vous avez configurés. Si vous avez fourni une charge utile, W&B l’envoie.
   Si le test échoue, vérifiez la configuration du webhook et réessayez. Si nécessaire, reportez-vous à Dépanner votre webhook.

​

Créer une automatisation

​

Afficher et gérer les automatisations

​

Référence de la charge utile

​

Variables de charge utile

​

Exemples de charges utiles

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

​

Dépanner votre webhook

#!/bin/bash

# Votre jeton d’accès et votre secret
ACCESS_TOKEN="your_api_key"
SECRET="your_api_secret"

# URL du point de terminaison de votre webhook
API_ENDPOINT="https://your.webhook.endpoint/path"

# Les données à envoyer (par exemple, au format JSON)
PAYLOAD='{"key1": "value1", "key2": "value2"}'

# Générer la signature HMAC. Pour des raisons de sécurité, W&B inclut l’en-tête
# X-Wandb-Signature, calculé par HMAC-SHA-256 à partir de la charge utile
# et du secret partagé associé au webhook.
SIGNATURE=$(echo -n "$PAYLOAD" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $2}')

# Envoyer la requête cURL
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Wandb-Signature: $SIGNATURE" \
  -d "$PAYLOAD" "$API_ENDPOINT"