Releaseo
Start free

Documentation

Install once. Keep every release easy to find.

Start with the recommended npm package or the direct CDN loader, then use the API reference when your app needs custom behaviour. Every page maps to the public Releaseo runtime.

Install the SDKView @releaseo/sdk on npm

First integration

A simple path through the docs

Most teams only need the first step. The next two are there when you are ready.

  1. Install @releaseo/sdk

    Install one package and initialize it with your publish key. The compatible runtime loads automatically.

  2. Identify signed-in visitors

    Pass the viewer’s stable id and safe traits after your own app signs them in.

  3. Announce a release in-app

    Choose a banner, toast, or modal in Releaseo — no new UI component to mount.

Need a method? Open the complete SDK API reference →

Start here

Pick an integration path and install the SDK.

StartInstallation

Recommended npm setup, direct CDN, framework adapters, and hosted defaults.

StartCDN quick start

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.

Recommended@releaseo/sdk

Typed npm facade with automatic compatible runtime delivery from the Releaseo CDN.

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.

Advanced@releaseo/sdk-core

Direct, version-pinned host runtime for applications that require a fixed bundled version.

Reference

The complete runtime API, function by function.

ReferenceSDK API reference

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

Product

In-app announcements, widget surfaces, backend contract, and integrations.

Public siteHosted public site

A branded changelog, roadmap, feedback board and help centre on your own domain, hosted by Releaseo.

LaunchesIn-app Launches

Show a banner, toast, or modal on the host page. Learn the right surface, triggers, and delivery rules.

WidgetWidget surfaces

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

Customer supportSet up Live Chat

Allow your websites, configure a support team, connect the widget, and verify customer sessions.

Customer supportWork live conversations

Reply to customers, add internal notes, manage assignment and status, and continue after a handoff.

Customer supportRIO in Live Chat

Choose AI answers or staff suggestions, maintain published knowledge, and control human handoff.

Customer supportConversation Flows

Build branching support journeys with questions, articles, AI answers and team handoff, then preview and publish.

MonitorMonitor

Observe a business process like checkout or signup. Your backend reports each step; Releaseo shows a live funnel and alerts Slack or Discord on failure or completion.

APIHelp Center API

Read published articles from your server, manage project keys, and integrate search, languages and caching.

APIBackend contract

Public SDK endpoints, dashboard ownership, and visibility rules.

IntegrationsGitHub, Slack, Discord, and event routing

Sync releases, issues, and roadmap work with GitHub; broadcast updates, forward analytics, and deliver signed webhooks.

Guides

Long-form walkthroughs and platform context.

GuideReleaseo overview: every release communication surface, explained

How Releaseo's surfaces fit together: changelog, in-app launches, feature requests, roadmap, help centre, inbox, segments, Monitor, widget and public site.

GuideThe Releaseo widget: what it shows and how to install it

What the embeddable Releaseo widget shows, how to install it with one script tag or npm, how to identify users, and what it does to your bundle and cookies.

Was this page helpful?