Tutorial: Registry artifact alias automation

Documentation Index

Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Prerequisites

• A webhook configured in Team Settings.
• A W&B registry with at least one collection, or reuse an existing registry.

​

Create a registry automation

1. Open the registry and click the Automations tab, then click Create automation.
2. Choose the event An artifact alias is added. Enter an Alias regex that matches the alias you care about (for example, production or staging).
3. Click Next step. Set Action type to Webhooks and select your webhook. If the webhook expects a payload, paste a JSON body and use payload variables such as ${artifact_collection_name} and ${artifact_version_string}.
4. Click Next step. Give the automation a name and optional description, then click Create automation.

​

Test the automation

import wandb

with wandb.init(project="my-project") as run:
    artifact = wandb.Artifact("my-model", type="model")
    # ... log files or metadata to artifact as needed ...
    run.log_artifact(artifact)
    run.wait()  # Ensure the artifact is logged before proceeding

# Add an alias to the latest version in the collection
api = wandb.Api()
collection = api.artifact_collection(name="my-model", type_name="model")
version = next(collection.versions())  # Get the latest version

version.aliases.append("production")
version.save()
print("Added alias 'production' to", version.name)

​

Go further

• Automation events and scopes for all project and registry event types.
• Create a Slack automation and Create a webhook automation for full UI and payload details.