Returning.AI
  1. Incoming webhooks
Returning.AI
  • Returning.AI
    • Authentication
    • System API
      • Auth
        • secure auth
        • register
        • verify email
        • login
      • Server
        • create new server
        • get my servers
        • update server
        • role list of server
        • channel list of server
      • Channel
        • get channels list
        • create new channel
        • update channel
        • delete channel
      • Role
        • create new role
        • update role
        • delete role
        • add role to a user on a server
        • remove role from a user on a server
        • get role list of user on a server
      • Badge
        • get badges list
        • create new badge
        • update badge
        • delete badge
        • award badge to user
        • remove badge from user
    • Integration API
      • Users
        • Create New User
        • Get User Data
        • Get Users with Filters
        • Manage User account
        • Get User Gamification History
        • Get User Gamification Stats
        • Bulk Import
        • Bulk Update
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
      • User Api Key
        • Get User Api Key
        • Post User Api Key
        • Update User Api Key
        • Delete Endpoint
        • api key info
    • Application API
      • Community Users
        • Get community users
        • Get user
      • User Fields
        • Get all user fields for a community
        • Get specific user field
        • Create user field
        • Update user field
        • Delete user field
      • User Field Histories
        • 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
    • 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
  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 2025-09-03 09:55:59
Previous
Update Custom User Fields