Returning.AI
  1. Outgoing webhooks
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • role list of server
          • create new role
          • update role
          • delete role
          • get role list of user on a server
          • add role to a user on a server
          • remove role from a user on a server
        • Badge
          • get badges list
          • create new badge
          • update badge
          • delete badge
          • award badge to user
          • remove badge from user
      • Application API
        • Community Users
          • Get community users
          • Get user
        • User Fields
          • Get All User Fields
          • Get Specific User Field
          • Create Custom User Field
          • Update Custom User Field
          • Delete Custom 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
      • Integration API
        • Users
          • Get Users with Filters
          • Create New User
          • Get User Data
          • Manage User Account
          • Get User Gamification History
          • Get User Gamification Stats
          • Bulk Import
          • Bulk Update
        • Messages
          • Get Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
        • Xp Settings
          • Get Tier Info
      • User API
        • API key
          • api key info
          • Delete Endpoint
          • Update User Api Key
          • Post User Api Key
          • Get User Api Key
        • Messages
          • React Message
          • Reply Message
          • Send Message
    • Channels
      • Iframe
    • 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
    • Widgets
      • Authenticated widgets
      • Public widgets
    • 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