Documentation

Build an Aven Web registry

The registry is a versioned declaration of product context. It contains pages, guideable elements, and workflows; Aven uses this declared information rather than controlling arbitrary browser UI.

Aven.registerPage({ pageId: "settings", name: "Settings", route: "/settings" });
Aven.registerElement("settings", { elementId: "api-key", selector: "[data-aven=api-key]", name: "API key" });

Pages and elements

Use stable IDs for logical pages and UI elements. On the Web, selectors identify the declared element; make sure the target exists when the host says it is ready.

Workflows and completion

A workflow is an explicit sequence of registered product steps. Define it for a real task, then use the supported completion behavior in your SDK integration.