Returning.AI
  1. Incoming webhooks
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • role list of server
          • create new role
          • update role
          • delete role
          • get role list of user on a server
          • add role to a user on a server
          • remove role from a user on a server
        • Badge
          • get badges list
          • create new badge
          • update badge
          • delete badge
          • award badge to user
          • remove badge from user
      • Application API
        • Community Users
          • Get community users
          • Get user
        • User Fields
          • Get All User Fields
          • Get Specific User Field
          • Create Custom User Field
          • Update Custom User Field
          • Delete Custom 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
      • Integration API
        • Users
          • Get Users with Filters
          • Create New User
          • Get User Data
          • Manage User Account
          • Get User Gamification History
          • Get User Gamification Stats
          • Bulk Import
          • Bulk Update
        • Messages
          • Get Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
        • Xp Settings
          • Get Tier Info
        • Integration Api Key
          • Get Integration Api Key
          • Post Integration Api Key
          • Delete Integration Api Key
          • Integration Api Key Info
          • Update Integration Api Key
      • User API
        • API key
          • Get User Api Key
          • api key info
          • Post User Api Key
          • Delete Endpoint
          • Update User Api Key
        • Messages
          • Send Message
          • Reply Message
          • React Message
    • 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
  1. Incoming webhooks

Update Custom User Fields

Incoming webhooks can be use to edit a user's custom field 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 User field.
6.
Select a custom field.
7.
Select an operator and choose the field input from the webhook payload
Numerical fields can be added, subtracted or overwritten, non-numerical fields can only be overwritten.
image.png
8.
Repeat from step 5 to add more fields.
9.
Additional fields can be merged with Update In-game currency

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:27
Previous
Send message into channels
Next
Update In-game currency