Returning.AI
    • Getting Started
    • Users
      • Get user
        GET
      • Get Users with Filters
        POST
      • Create New User
        POST
      • Get User Data
        POST
      • Manage User Account
        POST
      • List mini-game logs by user email
        POST
      • Get user's current Mini Games and Streak stats
        POST
      • Get User Milestones
        POST
      • Update User Data, Identifier, And Roles
        POST
      • Update User XP and Currency
        POST
    • Messaging
      • Agent messaging workflow
      • Get Messages
        GET
      • Send Message
        POST
      • Reply Message
        POST
      • React Message
        POST
      • Upload message images
        POST
    • Gamification
      • Leaderboards
        • List leaderboards with pagination
        • Create a new leaderboard
        • Update an existing leaderboard
        • Get a single leaderboard by ID
        • Delete a leaderboard
      • Streaks & Mini Games
        • List user streak logs
        • Update user spin-wheel information
      • Referral
        • Get referral programs
        • Get user's referral summary
      • Rolling Data
        • Get Daily Calculation Data
        • Get Rolling Calculation Data
      • Match Predictions
      • Get tiers and XP settings
        GET
      • Get daily user gamification history
        POST
      • List user gamification logs
        POST
      • Get user activity stats
        POST
    • Rewards & Redemptions
      • Update redemption order status or refund
      • List redemption orders by user email
      • List redemption statuses
      • Get redemption status by ID
      • List redemption orders by community
      • Create redemption order status
      • Get redemption order status history
    • Chart Analysis
      • Create Analysis
      • Get Analysis
      • Update Analysis
      • Delete Analysis
      • List Analyses
      • Append Drawings
    • Bulk Operations
      • List bulk update jobs
      • Get bulk update job status
      • Get bulk update job details
      • Bulk update users from CSV
      • Bulk update premium currency from CSV
    • Channels
      • Iframe
      • List integration channels
    • 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
    • Community Analytics
      • Get Loyalty Overview
      • Get Phone Verification Contacts
    • Store
      • Purchase History
        • Update redemption instructions or voucher details
      • Categories
        • List Store categories
        • Create Store category
        • Get Store category by ID
        • Update Store category
        • Delete Store category
      • Products
        • List products
        • Update products in bulk
        • Create products in bulk
        • Create product with vouchers
        • Read product
        • Update product and append vouchers
        • Delete product
      • Redemption-transaction
        • Get redemption transaction detail
      • Get Store configuration
      • Update Store configuration
    • Community
      • Appearance
        • Update community theme colors
        • Update community bot profile
        • Update community URL metadata
        • Update community name and URL
      • Community Users
        • Get community users
        • Get user
      • Create community
    • API Keys
      • Community API Keys
        • Create API key
        • Read API keys
        • Delete API key
        • Update API key
      • User API Keys
        • List user API keys
        • Create user API key
        • Update user API key
        • Delete user API key
        • Get current API key information
    • User Fields
      • User Field History
        • 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
        • Update A User Field Value
        • Deprecated Field-First History Write
        • Deprecated Field-First History Read
      • Get A User Field Definition
      • Update A User Field Definition
      • Create A User Field Definition
      • Delete A User Field Definition
      • List User Field Definitions
      • Delete user field
      • Update user field
      • Get specific user field
    • Legacy
      • Servers
        • Create server
        • List servers
        • Update server metadata
      • Bulk Operations
        • Bulk import users from CSV
      • Authentication
        • Secure Auth
        • Register user with password
        • Verify user email
        • Log in user with password
      • Badges
        • List badges
        • Create badge
        • Update badge
        • Delete badge
        • Remove badge from user
        • Award badge to user
      • Messaging
      • Roles & Permissions
        • List server roles
        • Create role
        • Update role
        • Delete role
        • List user roles
        • Add role to user
        • Remove role from user
      • Users
        • Upload user avatar
      • Channels
        • Create channel
        • Update channel
        • Delete channel
      • API Keys
        • List integration API keys
        • Create integration API key
        • Delete integration API key
        • Update integration API key
    • Schemas
      • Sample Schemas
      • Schemas
      • Outgoing webhooks
      • Analysis
      • Pet
      • Category
      • Tag
      • ValidationError
      • NotFoundError
      • InternalServerError
      • NotImplementedError
      • CreateUserFieldHistoryResponse
      • CreateUserFieldHistorySuccessResponse
      • UserFieldHistoryItem
      • GetUserFieldHistoriesResponse
      • UserFieldHistoriesValidationError
      • UserFieldHistoriesMetaWithValidation
      • UserFieldHistoriesMetaWithPagination
      • GetUserFieldHistoriesSuccessResponse
      • CreateUserFieldResponse
      • CreateUserFieldSuccessResponse
      • DeleteUserFieldResponse
      • DeleteUserFieldSuccessResponse
      • UserFieldCreator
      • GetUserFieldResponse
      • GetUserFieldSuccessResponse
      • ValidationErrorItem
      • GetUserFieldsMetaResponse
      • CreatorInfo
      • UserFieldResponse
      • GetUserFieldsSuccessResponse
      • UpdateUserFieldResponse
      • UpdateUserFieldPayload
      • UpdateUserFieldSuccessResponse
      • MetaResponse
      • GetUserResponse
      • GetUserSuccessResponse
      • Purchased store item
      • ErrorResponse
      • New message posted to channel
      • UpdateAnalysisRequest
      • User visits server
      • AppendDrawingsRequest
      • User join server
      • CreateAnalysisResponse
      • GetAnalysisResponse
      • UpdateAnalysisResponse
      • AppendDrawingsResponse
      • AnalysisMetadata
      • Expiry
      • Levels
      • LevelEntry
      • Drawing
      • HorizontalLineDrawing
      • LineDrawing
      • RectangleDrawing
      • ParallelDrawing
      • FibonacciRetracementDrawing
      • Coordinate
      • DrawingStyle
      • AnalysisDetail
      • AnalysisSummary
      • CreateAnalysisRequest
      • ListAnalysesResponse
      • StandardApiError
      • StandardSuccessEnvelope
      • PurchasedStoreItemEvent
      • ChannelMessagePostedEvent
      • UserVisitedCommunityEvent
      • UserJoinedCommunityEvent

    Channels

    Channels are the core communication hubs, designed to foster community engagement. Admins are allowed to create customizable spaces where users can interact, share content, and engage with embedded web content seamlessly. Each channel supports powerful features to enhance user experience,
    1.
    Iframe Embedding: Display any website or iframe content directly within a channel, enabling rich integrations like live dashboards, external tools, or custom applications.
    2.
    Iframe Listener: Capture user data (e.g., user ID) when someone accesses a channel, enabling analytics or personalized experiences. This is handled via a lightweight JavaScript listener script.
    3.
    Deeplinking: Ensure smooth transitions within embedded iframes and the community without reloading the entire server.
    Channels are highly configurable, empowering admins to tailor them to specific use cases, such as discussion forums, annoucement page, or integrated third-party tools.

    Getting started#

    To start using channels:
    1.
    Head to community settings > channels
    2.
    Configure the channel name and descriptions.
    3.
    Types of Channels:
    Text: Chat channels where users can communicate with each other.
    Annoucements: Only assigned annoucers are able to send messages in this channel.
    Forum: Discussion forums
    4.
    Channel options:
    Public: All members of the community are able to view this channel
    Private: Permission are required to view, assign permissions to roles, tags or individual users.
    5.
    Channel permissions:
    Set unique permissions to roles, tags or individual users such as: viewing, posting messages, mentions, etc.
    6.
    Embed Iframe:
    Click to learn more about Iframe embeds.
    7.
    Widgets
    Click to learn more about channel widgets.
    Modified at 2026-03-24 09:39:51
    Previous
    Bulk update premium currency from CSV
    Next
    Iframe
    Built with