Documentation

Ship the Releaseo widget without surprises.

Static MDX docs for installation, runtime APIs, React and Vue adapters, widget surfaces, and dashboard integrations.

Start here

Pick an integration path and install the SDK.

CDN, npm, async loading, hosted defaults, and widget open examples.

Two script tags, no build step. A real, copy-paste walkthrough: full page, identify users, wire your own buttons, async loading.

Packages

Runtime APIs and framework adapters.

Package @releaseo/sdk-core

Host runtime API for init, open, close, identity handoff, logout, and reset.

Package @releaseo/react

Headless React provider, hooks, unread state, widget actions, and SSR notes.

Package @releaseo/vue

Headless Vue plugin, composables, unread state, widget actions, and Nuxt notes.

Reference

The complete runtime API, function by function.

Reference SDK API reference

Every window.releaseo function — signatures, parameters, returns, and examples for lifecycle, identity, widget controls, analytics, consent, host actions, and events.

Product

Widget surfaces, backend contract, and integrations.

Widget Widget surfaces

Feature requests, roadmap data, public behavior, tabs, and Home Hub settings.

API Backend contract

Public SDK endpoints, dashboard ownership, and visibility rules.

Integrations PostHog and Webhook Out

Selectable event subscriptions, multi-destination webhooks, HMAC delivery, and contact events.

Guides

Long-form walkthroughs and platform context.

Guide Platform overview

Markdown overview of the Releaseo release communication shape.

Guide SDK widget

MDX overview of the Releaseo widget and installation story.