1. Incoming webhooks
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
    • get my servers
    • update server
  • 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. Incoming webhooks

Update In-game currency

Incoming webhooks can be use to add/subtract a user's in game currencies from external systems.

Set up#

1.
Create a Incoming webhook and set up the names, api key and/or encryptions.
2.
Select User Fields as the webhook location.
3.
Send a test request to the Incoming Webhook URL, then click Catch to capture a sample payload.
There is no JSON body format requirememt, as along as all the required fields are present.
4.
Under Map to User, select a user identifier - email or username. Select the field and choose the identifier from the payload
image.png
5.
Click on Add field mapping and select Currency field.
6.
Select XP or Coins as the currency.
7.
Currency can be added or subtracted by selecting the operator before the field.
image.png
8.
Repeat from step 5 to add more currencies.
9.
Additional fields can be merged with Update Custom User Fields

Logs#

Open histories (top-right of the Webhooks page) to view all received webhooks. Each delivery shows a status:
Success (green tick) — executed successfully.
Failed (red cross) — execution error; see the Details tab for the reason.
Pending (grey circle) — queued; no attempt made yet. If still pending after 1 hour, contact an admin.
Coins/XP awarded via webhooks appear under Community Settings > Gamification Logs.
The webhook’s name is recorded as the action for each log entry.
Modified at 2026-03-24 09:39:51
Previous
Update Custom User Fields
Next
Widgets
Built with