Returning.AI
  1. Events
Returning.AI
  • Returning.AI
    • Authentication
    • System
      • 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
      • 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
      • 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. 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 2025-09-03 02:59:27
Previous
Purchased Store Item
Next
API Keys & Encryption