1. Events
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 channels list
    • create new channel
    • update channel
    • delete channel
    • Get Channels List
  • 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
    • 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
  • Community Analytics
    • Get Loyalty Overview
  1. Events

Incoming webhooks

Incoming webhooks let external systems call your community and perform actions—such as updating a member’s coins/xp, setting custom fields, or posting a message to a channel as a bot.

Set up#

1.
Go to Community Settings → Integrations → Webhooks.
2.
Click New incoming webhook and configure:
Webhook name (to be shown in logs)
Optional API key and Encryption (More details found in the encryption explaination)
Select a webhook loacation (Chat or User fields)
Copy the Incoming Webhook URL from the top right to be used in the external system.
3.
Click Save and the webhook can be triggered.
4.
Trigger the webhook at least once to use the data collected from the webhook.
After sending data to the webhook, click on catch to load the data.
Click on the webhook form to enter the data (More details found in each webhook explaination)
You can create multiple webhook for different updates. Existing webhooks can be edited or deleted at any time.

History#

All received webhook deliveries are logged. View them from Histories in the top-right of the Webhooks to review responses and if they were executed correctly and troubleshoot as needed.
There are 3 States for the webhook
1.
Success
2.
Failed - reason will be logged in histories
3.
Pending - contact admin if responses are stuck in this state for too long.
Modified at 2026-03-24 09:39:51
Previous
Purchased Store Item
Next
API Keys & Encryption
Built with