Reference — Migration

Migrating from 3.2.0 to 4.0.0

Renames openWaymark businessURL option to sourceUrl

The waymark.openWaymark method's businessURL option has been deprecated in favor of sourceUrl for consistency with other Waymark naming conventions going forward. This should be as simple as updating any uses of businessURL to sourceUrl.

waymark.openWaymark({
-  businessURL: "https://example.org",
+  sourceUrl: "https://example.org",
});

Improved iframe management

The Waymark Plugin now includes enhanced iframe lifecycle management that makes your integration more resilient with minimal changes required.

The Plugin maintains a persistent connection to an iframe for communicating with Waymark APIs. Previously, if this iframe was disconnected from the page, the Waymark instance would break and require reinitialization. Now, the Plugin automatically recovers by creating a new hidden iframe at the document body root and re-establishing the connection.

When you're ready to display the Waymark UI again, use the new waymark.mount() method to attach the iframe to your desired parent element.