Returning.AI
  1. Returning.AI
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • role list of server
          • create new role
          • update role
          • delete role
          • get role list of user on a server
          • add role to a user on a server
          • remove role from a 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 Key
          • Integration Api Key Info
          • Get Integration Api Key
          • Post Integration Api Key
          • Delete Integration Api Key
          • Update Integration Api Key
      • 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
          • Get All Bulk Update
          • Check Bulk Update Status
          • Check Bulk Update Details
        • Messages
          • Get Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
        • Xp Settings
          • Get Tier Info
      • User API
        • API key
          • Get User Api Key
          • Post User Api Key
          • Update User Api Key
          • Delete Endpoint
          • api key info
        • 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
      • Authenticated Widgets
      • Public widgets
    • Features
  1. Returning.AI

Widgets

Widgets are lightweight components of features that can be embed directly into your website or application. Once added, they display seamlessly and automatically update whenever changes are made in the settings.
Each widget has a unique identifier, so multiple widgets can be activated and embedded on the same page without conflict.

Whitelisted domain(s)#

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

Types of widget#

The platform supports two types of widgets:

Public widgets#

Visible to all visitors on the embedded site.
Displays as a read-only widget.
Supports a customizable Call-To-Action (CTA) button.
Simple <iframe> code to be added at where the widget would appear.

Authenticated Widget#

Requires users to be authenticated before interacting.
Enables personalized and interactive functionality inside the widget (instead of just read-only).
Commonly used in client portals or members-only areas after login.

Customization#

Widgets can be customized to fit your site’s look and feel:
Sizing → Choose between dynamic sizing or fixed width/height.
Theme Color → Match your brand’s primary colors.
CTA Button → Customize text, styling, and behavior.

Features that support widgets:#

Channels
Leaderboard
Milestone
Socials
Store
Click in to learn more about feature specific widgets.
Modified at 2025-09-10 03:45:49
Previous
Update In-game currency
Next
Authenticated Widgets