1. Incoming webhooks
Returning.AI-dev-wip
  • 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
    • Upload User Avatar
      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
      POST
    • get my servers
      GET
    • update server
      PUT
  • 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
    • award badge to user
    • delete badge
    • remove badge from user
    • Get Tier Info
    • Get User Gamification History
    • Get User Gamification Logs
  • Streaks & Mini Games
    • Get Streak Logs
    • Get all mini game logs by user email
    • Get user's current Mini Games and Streak stats
    • Update user wheel info (spins and/or streaks) by email
  • Rewards & Redemptions
    • Update redemption transaction status
    • Get all redemption transactions by user email
    • Get All Redemption Statuses
    • Get Redemption Status by ID
    • Create Redemption Status
    • Get all redemption transactions by Community
    • Get Redemption Transaction History
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • List Analyses
    • Append Drawings
    • Delete Analysis
  • Bulk Operations
    • Check Bulk Update Details
    • Check Bulk Update Status
    • Premium Currency Bulk Update
    • Get All Bulk Update
    • Bulk Update
    • Bulk Import
  • Application API
    • Community Users
      • Get community users
      • Get user
  • Integration API
    • Community Analytics
      • Get Loyalty Overview
    • Streaks
      • Update Streak Settings
      • Get All Streaks
      • Create Streak
      • Update Streak
      • Delete Streak
  • Channels
    • Iframe
  • Widgets
    • Authenticated Widgets
    • Public widgets
  • 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
  • Features
  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