Oyster Widget Developer Docs

Pick the widget API version you’re integrating. v1 introduces embedded inline mode (mount into a provided container) and new autoOpen semantics.

v1 (recommended)

Inline embeds into your page via container. No floating toggle button in inline mode. autoOpen controls whether anything renders automatically.

Open v1 docs →

v0.2.0 (legacy)

Legacy semantics where inline didn’t require a container and minimize could show the floating launcher. Keep this only if you’re pinned to v0.2.0.

Open v0.2.0 docs →

Pin versions

In production, prefer pinning to the latest major (for example /v1/) so you receive updates and patches. Use /vX.Y.Z/ if you need fully immutable builds, and use /latest/ only for testing.