HomeSupport

Embedding the Widget

Embed the widget in your website or app with a few lines of code.

The embed widget offers a seamless way to integrate release notes into your application or website. With a simple click on a trigger in form of a link or button, users can access a dialog box displaying the most recent announcements. Additionally, the trigger conveniently displays a badge indicating the presence of new announcements.

Installation instructions

1

Copy the channel ID

Copy the channel ID for the embed widget.

2

Select which modules to include

Choose whether to embed the Changelog, the Roadmap, or both by selecting which modules to include in the embed.

Select which modules to include
3

Add the embed script

Add the following code snippet to the <head> section of your site.

<script src="https://embed.released.so/1/embed.js" defer></script>
4

Add the released-widget element to your page

Add the following code snippet to the <body> section of your site. The widget will not be rendered inline, so it does not matter where in the body you position the element. Ensure you replace the CHANNEL_ID attribute.

<released-widget channel-id="CHANNEL_ID"></released-widget>

If your portal has restricted access, you’ll need to implement user verification and pass the auth-token="AUTH_TOKEN" attribute to display content in your embed.

Optional step

1

Customize the widget (optional)

Customize the widget to match your brand and app design using the widget properties. Adjust the title and description, or change the colors according to your preferences.

Please see the documentation for a full list of configuration options.

Example

View an example of how to embed the widget on CodePen.

PreviousInstalling ReleasedNextEmbedding the Page

Last updated

Was this helpful?