1. Outgoing 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
    • get my servers
    • update server
  • 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. Outgoing webhooks

User Joins Server

Triggers when a user successfully joins the server.

Payload#

User join server

Example (JSON)#

{
  "owner": {
    "id": "1342,
    "name": "John Doe",
    "avatar": "https://example.amazonaws.com/01f0.gif",
    "email": "johndoe@example.com"
  },
  "user": {
    "id": "1234",
    "firstName": "Jane",
    "lastName": "Doe",
    "name": "Jane Doe",
    "avatar": "https://www.example.com/img/user-avatar.png",
    "email": "janedoe@example.com",
    "nicename": "janedoe", #username
    "displayname": "Jane Doe",
    "language": "en",
    "communityRole": [
      "@all"
    ],
    "referredBy": "johndoe" #username of user who referred
  },
  "date": "2025-08-31T10:13:52.863Z",
  "event": {
    "name": "User Joins Server",
    "description": "Triggers when a user joins the server"
  },
  "server": {
    "id": "6502564c5c09c0a",
    "name": "John's community"
  }
}
Modified at 2025-09-03 10:29:27
Previous
Encryption
Next
User Visits server