Released Documentation
HomeSupport
  • Getting started
    • Overview
    • Concepts
    • Setup Guide
      • Installing Released
      • Embedding the Widget
      • Embedding the Page
      • Implementing User Verification
      • Changelog Description Field (optional)
  • Permissions
  • Global Settings
    • General
    • Custom domain
    • Design
    • Internal Domains
    • User Verification
  • Workspace
    • Overview
    • Dashboard
    • Changelog
      • AI Settings
      • Changelog filter
      • Creating and Managing Posts
      • Writing a Post
      • Publishing Updates
      • Templates
      • Editor
        • Images
        • Videos
        • Emojis
        • Keyboard Shortcuts
        • Categories
        • Versions
      • Filter
    • Roadmaps
    • Settings
      • General
      • Access
      • Portal
        • Page Embed
        • Widget Embed
      • Publishing
        • Confluence
        • Email
        • Jira issue links
    • Integrations
      • Framer
      • Webflow
      • Slack
      • Aura
      • Cosmos
      • Karma
      • Scroll Viewport for Confluence
  • Resources
    • AI Tips
      • Create Output in Other Languages
      • Include a Documentation Link in the Output
      • Creating Structured Output
    • Troubleshooting
      • Permissions Issues
    • How-Tos
      • Accessing Custom Fields
      • Configuring Dark Mode
      • Finding the Channel ID
      • Ensuring JavaScript Resource Stability for PCI Compliance
      • How to Open the developer console to check for errors
      • How to Apply Atlassian Marketplace App Promo Codes for Cloud
      • Configuring Content Security Policies (CSP) for Released Embeds
Powered by GitBook
On this page
  • Installation instructions
  • Optional step
  • Example

Was this helpful?

  1. Getting started
  2. Setup Guide

Embedding the Widget

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

PreviousInstalling ReleasedNextEmbedding the Page

Last updated 6 days ago

Was this helpful?

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

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.

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 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 .

Example

View an example of how to embed the widget on .

Copy the channel ID
implement user verification
configuration options
CodePen
Select which modules to include