1. Channels
Returning.AI
  • 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
    • Get all mini game logs by user email
      POST
    • Get user's current Mini Games and Streak stats
      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
    • delete badge
    • remove badge from user
    • award badge to user
    • Get Tier Info
    • Get User Gamification History
    • Get User Gamification Logs
  • Streaks & Mini Games
    • Streak Logs
      • Get Streak Logs
  • Rewards & Redemptions
    • Update redemption transaction status
    • Get all redemption transactions by user email
    • Get All Redemption Statuses
    • Get Redemption Status by ID
    • Get all redemption transactions by Community
    • Create Redemption Status
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk Import
    • Get All Bulk Update
    • Check Bulk Update Status
    • Check Bulk Update Details
    • Bulk Update
    • Premium Currency Bulk Update
  • Application API
    • Community Users
      • Get community users
      • Get user
  • Integration API
  • 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
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • 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
    • Outgoing webhooks
      • Purchased store item
      • New message posted to channel
      • User visits server
      • User join server
      • ErrorResponse
    • Analysis
      • UpdateAnalysisRequest
      • AppendDrawingsRequest
      • CreateAnalysisResponse
      • GetAnalysisResponse
      • UpdateAnalysisResponse
      • AppendDrawingsResponse
      • AnalysisMetadata
      • Expiry
      • Levels
      • LevelEntry
      • Drawing
      • HorizontalLineDrawing
      • LineDrawing
      • RectangleDrawing
      • ParallelDrawing
      • FibonacciRetracementDrawing
      • Coordinate
      • DrawingStyle
      • AnalysisDetail
      • AnalysisSummary
      • CreateAnalysisRequest
      • ListAnalysesResponse
  1. Channels

Iframe

Display any website or iframe content directly within a
channel.

Embeds#

1.
Insert the Iframe code in the input box directly,
Example:
<iframe 
    src="https://prod-widgets.returning.ai/channel-   widget/NjUwN2M4NjFkJkYTYxNTAzYkY2U5/open-widget" 
    id="returningAiWidgetIframe" 
    frameborder="0" 
    width="100%" 
    height="100%">
</iframe>
2.
Insert a URL to embed
https:// must be included in the URL.
Example: 
https://returning.ai/

Iframe listener script#

Capture user data (e.g., user ID) when someone accesses a channel, enabling analytics or personalized experiences.
Paste the provided script in the header of the site, when a user visits the channel, their user information will be send over.
Payload:
{
    "displayName": "John Doe",
    "email": "johndoe@gmail.com",
    "isGuest": undefined,
    "language": "en",
    "userID": "1234",
    "username": "johndoe"
}

Iframe deeplinks#

Ensure smooth transitions within embedded iframes and the community without reloading the entire server.
Found in community settings > integration > Iframe Deep Links
Insert the deeplink script in your embeded site to allow users to navigate to other parts of the community seamlessly without having to reload the server.
Example:
In the embeded site, it shows the milestone available and have a interactable button: See all milestones.
Copy the Deep link script given and link it to the button.
When a user clicks on the button, they should be led to the milestone page in the community without opening a new tab (iframe link logic)
example of the script: 

window.parent.postMessage({
  type: 'IFRAME_DEEP_LINK',
  pageName: 'quests-milestones'
}, '*');
Modified at 2026-03-24 09:39:51
Previous
Channels
Next
Events
Built with