Returning.AI
    • Getting Started
    • Authentication
      • Register user with password
        POST
      • Verify user email
        POST
      • Log in user with password
        POST
      • Secure Auth
        GET
    • 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
    • Messaging
      • Message Actions
        • Direct Channel
          • private DM channel
            • Reply Message
            • Send Message
            • React Message
          • public channel
            • Reply Message
            • Send Message
            • React Message
        • Forum Channel
          • Send Message
          • Reply Message
          • React Message
        • Text Channel
          • Reply Message
          • Send Message
          • React Message
        • Iframe Channel
          • Reply Message
          • Send Message
          • React Message
      • 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
        • Get a single leaderboard by ID
        • Update an existing leaderboard
        • Delete a leaderboard
      • Streaks & Mini Games
        • List user streak logs
        • Update user spin-wheel information
      • 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
        PUT
      • List redemption orders by user email
        POST
      • List redemption statuses
        POST
      • Get redemption status by ID
        POST
      • List redemption orders by community
        POST
      • Create redemption order status
        POST
      • Get redemption order status history
        POST
    • 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
    • Store
      • Purchase History
        • Update purchase history redemption instructions or voucher details
      • Categories
        • List store categories
        • Create store category
        • Update store category
        • Delete store category
        • Get store category by ID
      • Products
        • List store products
        • Create store product
        • Update store product
        • Delete store product
        • Get store product by ID
      • 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
        • Create user field history for specific user
        • Create user field history
        • Get user field histories
      • Get Specific User Field
      • Update Custom User Field
      • Create user field
      • Delete Custom User Field
      • Get all user fields for a community
      • 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
      • Badges
        • List badges
        • Create badge
        • Update badge
        • Delete badge
        • Remove badge from user
        • Award badge to user
      • Messaging
        • Reply to message
        • Send message
        • React to message
      • 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

    Webhooks

    This section covers the platform's event system, such as outgoing webhooks (notifications sent from the platform to your external systems upon specific triggers) and incoming webhooks (requests sent to the platform from external systems to perform actions like updating fields or sending messages via a bot user).
    Modified at 2026-03-24 09:39:51
    Previous
    List integration channels
    Next
    Outgoing webhooks
    Built with