Returning.AI-dev-wip
    • Getting Started
    • Authentication
      • Secure Auth
        GET
      • register
        POST
      • verify email
        POST
      • login
        POST
    • Users
      • Get user
        GET
      • Get Users with Filters
        POST
      • Create New User
        POST
      • Get User Data
        POST
      • Manage User Account
        POST
      • Get User Gamification Stats
        POST
      • Upload User Avatar
        POST
    • Roles & Permissions
      • role list of server
        GET
      • create new role
        POST
      • update role
        PUT
      • delete role
        DELETE
      • get role list of user on a server
        GET
      • add role to a user on a server
        POST
      • remove role from a user on a server
        POST
    • Servers
      • create new server
        POST
      • get my servers
        GET
      • update server
        PUT
    • Channels
      • channel list of server
        GET
      • get channels list
        GET
      • create new channel
        POST
      • update channel
        PUT
      • delete channel
        DELETE
      • Get Channels List
        GET
    • Messaging
      • Get Messages
      • Send Message
      • Reply Message
      • React Message
      • Upload Image
    • User Data
      • Get All User Fields
      • Get Specific User Field
      • Create Custom User Field
      • Update Custom User Field
      • Delete Custom User Field
      • 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
    • Gamification
      • get badges list
      • create new badge
      • update badge
      • award badge to user
      • delete badge
      • remove badge from user
      • Get Tier Info
      • Get User Gamification History
      • Get User Gamification Logs
    • Streaks & Mini Games
      • Get Streak Logs
      • Get all mini game logs by user email
      • Get user's current Mini Games and Streak stats
      • Update user wheel info (spins and/or streaks) by email
    • Rewards & Redemptions
      • Update redemption transaction status
      • Get all redemption transactions by user email
      • Get All Redemption Statuses
      • Get Redemption Status by ID
      • Create Redemption Status
      • Get all redemption transactions by Community
      • Get Redemption Transaction History
    • Chart Analysis
      • Create Analysis
      • Get Analysis
      • Update Analysis
      • List Analyses
      • Append Drawings
      • Delete Analysis
    • Bulk Operations
      • Check Bulk Update Details
      • Check Bulk Update Status
      • Premium Currency Bulk Update
      • Get All Bulk Update
      • Bulk Update
      • Bulk Import
    • Application API
      • Community Users
        • Get community users
        • Get user
    • Integration API
      • Community Analytics
        • Get Loyalty Overview
      • Streaks
        • Update Streak Settings
        • Get All Streaks
        • Create Streak
        • Update Streak
        • Delete Streak
    • Channels
      • Iframe
    • Widgets
      • Authenticated Widgets
      • Public widgets
    • 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
    • Features

    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
    Iframe
    Next
    Authenticated Widgets