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

Encryption

To enhance security, outgoing webhooks support data encryption using the AES-256 encryption algorithm in either CBC (Cipher Block Chaining) or GCM (Galois/Counter Mode) modes.
When enabled, the entire payload (JSON body) is encrypted before transmission, protecting sensitive information in transit.

Enabling Encryption#

During webhook setup or editing in Community Settings > Integrations > Webhooks, toggle on AES key and provide an AES encryption key and a IV in the designated field.
AES Key Requirements:
Must be exactly 32 characters long (256 bits).
Use a secure, randomly generated key (e.g., via a password manager or cryptographic tool) is recommended. Do not use weak or predictable keys.
Initialization Vector (IV):
16 characters long (128 bits).
Once the key is set, all subsequent outgoing webhooks to that endpoint will be encrypted.
Modified at 2025-09-02 09:01:18
Previous
Outgoing webhooks
Next
User Joins Server