Returning.AI
  1. Widgets
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • role list of server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • create new role
          • update role
          • delete role
          • add role to a user on a server
          • remove role from a user on a server
          • get role list of user on a server
        • Badge
          • get badges list
          • create new badge
          • update badge
          • delete badge
          • award badge to user
          • remove badge from user
      • Application API
        • Community Users
          • Get community users
          • Get user
        • User Fields
          • Get All User Fields
          • Get Specific User Field
          • Create Custom User Field
          • Update Custom User Field
          • Delete Custom User Field
        • User Field Histories
          • Get all user field histories in a community
          • Get user field histories for a specific field
          • Get user field histories for a specific user
          • Get user field histories of specific user field and user
          • Create user field history for specific user
      • Integration API
        • Users
          • Get Users with Filters
          • Create New User
          • Get User Data
          • Manage User Account
          • Get User Gamification History
          • Get User Gamification Stats
          • Bulk Import
          • Bulk Update
        • Messages
          • Get Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
      • User API
        • API key
          • api key info
          • Delete Endpoint
          • Update User Api Key
          • Post User Api Key
          • Get User Api Key
        • Messages
          • Send Message
          • Reply Message
          • React Message
    • Channels
      • Iframe
    • Events
      • Outgoing webhooks
        • Encryption
        • User Joins Server
        • User Visits server
        • New Message Posted Anywhere
        • New Message Posted To channel
        • Purchased Store Item
      • Incoming webhooks
        • API Keys & Encryption
        • Send message into channels
        • Update Custom User Fields
        • Update In-game currency
    • Widgets
      • Channels
      • Leaderboard
      • Milestone
      • Socials
      • Store
      • Currency Overview
  1. Widgets

Channels

The channel Widget enables you to embed a fully functional channel from your Returning.AI community into external websites. It offers both public read-only displays and authenticated chatting capabilities.

Installation#

1.
Enable widgets in your store settings on admin portal
Community settings → Channels
2.
Configure whitelisted domains for security
No domains added: The widget can be embedded and used on any domain.
Domains added: The widget can only be embedded and used on the listed domain(s).
3.
Configure widget's size
Dynamic
Fixed height and width
4.
Configure widget's appearance
Customise the theme of the widget to match your site.
5.
CTA Button (Only for public widgets)
CTA button appears at the product cards.
Button content and URL can be customised.
6.
Choose a widget type and follow the instruction below for installation

Widgets type#

Public Widget#

Show the channel messages without authentication.
Simple set up: Include the iframe code anywhere on your platform.
Display all messages in the channel.
Optional Call-to-Action (CTA) button on the bottom right.
Example Iframe code:

Authenticated Widget#

Full channel functionality with chatting capabilities.
Requires development effort for user authentication.
Users will have be able to interact and send messages via the widget.

Step 1: Backend Authentication (Server-Side Only)#

Implement an endpoint on your server that authenticates the user and fetches the token from our service.
API key is included in the bottom of the authenticated widget codes in admin panel.
Store the API key in environment variables on your server (e.g., process.env.WIDGET_API_KEY in Node.js).
Security Warning
Never expose your API key in client-side code! The API key should only be used on your backend server.
Examples:
Node.js/Express example
PHP example
Python/Django Example

Step 2: Frontend Implementation (Client-Side)#

Add this JavaScript to your frontend to handle authentication and token passing to the widget iframe. It calls your backend endpoint and uses postMessage for secure communication.

Step 3: Embed the Widget#

Embed the iframe in your HTML where you want the widget to appear. Ensure the frontend script from Step 2 is loaded on the same page.

Support#

For additional support, please contact our dedicated support team. We're here to help you maximize the potential of our APIs.
This widget is provided by Returning.AI. Usage is subject to the Returning.AI Terms of Service and Widget License Agreement.
Modified at 2025-09-25 10:05:04
Previous
Widgets
Next
Leaderboard