Create a webhook automation

A Registry admin can create automations in that registry. Registry automations are applied to all collections in the registry, including those added in the future.

1. Log in to W&B.

2. Click the name of a registry to view its details,

3. To create an automation scoped to the registry, click the Automations tab, then click Create automation. An automation that is scoped to a registry is automatically applied to all of its collections (including those created in the future).

   To create an automation scoped only to a specific collection in the registry, click the collection’s action ... menu, then click Create automation. Alternatively, while viewing a collection, create an automation for it using the Create automation button in the Automations section of the collection’s details page.

4. Choose the Event to watch for.

   1. Fill in any additional fields that appear, which depend upon the event. For example, if you select An artifact alias is added, you must specify the Alias regex.

   Click Next step.

5. Select the team that owns the webhook integration.

6. Set Action type to Webhooks. then select the webhook to use.

7. If you configured an access token for the webhook, you can access the token in the ${ACCESS_TOKEN} payload variable. If you configured a secret for the webhook, you can access it in the payload by prefixing its name with $. Your webhook’s requirements are determined by the webhook’s service.

8. Click Next step.

9. Provide a name for the automation. Optionally, provide a description. Click Create automation.

• Manage the registry’s automations from the registry’s Automations tab.
• Manage a collection’s automations from the Automations section of the collection’s details page.

From either of these pages, a Registry admin can manage existing automations:

• To view an automation’s details, click its name.
• To edit an automation, click its action ... menu, then click Edit automation.
• To delete an automation, click its action ... menu, then click Delete automation. Confiruation is required.

Send a repository dispatch from W&B to trigger a GitHub action. For example, suppose you have workflow that accepts a repository dispatch as a trigger for the on key:

on:
repository_dispatch:
  types: BUILD_AND_DEPLOY

The payload for the repository might look something like:

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

The contents and positioning of rendered template strings depends on the event or model version the automation is configured for. ${event_type} will render as either LINK_ARTIFACT or ADD_ARTIFACT_ALIAS. See below for an example mapping:

${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>"

Use template strings to dynamically pass context from W&B to GitHub Actions and other tools. If those tools can call Python scripts, they can consume the registered model artifacts through the W&B API.

• For more information about repository dispatch, see the official documentation on the GitHub Marketplace.

• Watch the videos Webhook Automations for Model Evaluation and Webhook Automations for Model Deployment, which guide you to create automations for model evaluation and deployment.

• Review a W&B report, which illustrates how to use a Github Actions webhook automation for Model CI. Check out this GitHub repository to learn how to create model CI with a Modal Labs webhook.

A team admin can test a webhook interactively with the W&B App UI.

1. Navigate to your W&B Team Settings page.
2. Scroll to the Webhooks section.
3. Click on the horizontal three docs (meatball icon) next to the name of your webhook.
4. Select Test.
5. From the UI panel that appears, paste your POST request to the field that appears.
6. Click on Test webhook. Within the W&B App UI, W&B posts the response from your endpoint.

Watch the video Testing Webhooks in Weights & Biases for a demonstration.