Returning.AI
  1. Incoming webhooks
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. Incoming webhooks

Send message into channels

Incoming webhooks can be used to send messages into selected channel(s).

Set up#

1.
Create a Incoming webhook and set up the names, api key and/or encryptions.
2.
Select chat as the webhook location.
The messages will be send base on the 'persona' created in the webhook, you can customise the
Profile picture
Display name: shown as the sender name. The same display name may be reused across webhooks.
Username: unique identifier (not visible to end users).
Message Language: set accurately to improve translation quality.

Message set up#

The message to send will be collected from the webhook payload,
1.
Send a test request to your Incoming Webhook URL, then click Catch to capture a sample payload.
2.
Scroll down and click on the message template box.
3.
In the popup, select fields from the captured JSON to build your message (you can insert plain text + dynamic values).
image.png
5.
Scroll to Post to and select the channel(s) where the message should be sent.

Message appearance setting#

How the message looked when being sent can be customised
1.
Highlighted background
E.g:
image.png
2.
Webhook label
E.g:
image.png
3.
Custom role
E.g:
image.png

Connection to outgoing webhook#

There are 2 outgoing webhooks that triggers upon any messages send in selected channel(s).
New Message Posted Anywhere
New Message Posted To channel
By default, messages sent by webhooks do not trigger these outgoing events.
To allow webhook-sent messages to trigger them, enable Normal message type.
Modified at 2025-09-03 08:55:04
Previous
API Keys & Encryption
Next
Update Custom User Fields