Guilded Client
  1. Websocket
Guilded Client
  • Intro
  • Community Libraries
  • Permissions Values
  • Reference
  • Webhooks
  • Chat
    • Get Embed for URL
      GET
    • Get Metadata
      GET
    • Get Channel Messages
      GET
    • Get Pinned Messages
      GET
  • List Items
    • Get List Items
      GET
    • Get List Item Note
      GET
  • Users
    • Modify User
      GET
    • Get Current User Verification
      GET
    • Send Verification Email
      POST
    • Verify Email Address
      GET
    • Get User Owned Steam Apps
      GET
    • Get User
      GET
    • Get User Profile
      GET
    • Get User Profile Posts
      GET
    • Get User Profile Post
      GET
    • Check Email Address
      GET
  • Teams
    • Get Team Presences
      GET
    • Get Team Info
      GET
    • Get Shallow Search Results
      GET
    • Submit Deep Search Query
      GET
    • Check Subdomain
      GET
    • Look up Teams
      GET
    • Check Team Name
      GET
  • Members
    • Get Team Members
    • Detail Team Members
    • Detail Voice Members
    • Sort Member IDs
    • Detail Team Bots
  • Channels
    • Get Team Channels
    • Get Team Channel
    • Get Group Archived Channels
    • Get Thread
    • Get Channel Threads
    • Get Channel Thread Count
    • Get Voice Channel Groups
  • Webhooks
    • Get Channel Webhooks
    • Execute Webhook
  • Guilded Meta
    • Redirect to App
    • Get App QR
  • Tournaments
    • Get Tournaments
    • Get Tournament
    • Get Tournament Info
    • Get Tournament Any Bracket Confirmed
    • Get Tournament from Invite
    • Get Tournament Hash Invites
    • Get Tournament Bracket Matches
    • Get Upcoming Tournaments
    • Get Completed Tournaments
    • Get Featured Tournaments
  • Websocket
    • Websocket
  1. Websocket

Websocket

wss://www.guilded.gg/ws/
websocket
There are three types of websocket connections you can establish (names arbitrary):
Global: receive platform-wide events like messages.
Team: receive team-specific events like member updates. Specify teamId.
Search: receive results for a deep search query. Specify temporary as true and prefix as deep-search-.

Request

Query Params
temporary
boolean 
optional
Used for deep search connections
prefix
enum<string> 
optional
Prefix for the connection
Allowed value:
deep-search-
EIO
string 
optional
Engine.IO version (socketio/engine.io)
Example:
3
transport
string 
required
Example:
websocket
jwt
string 
deprecated
Provided when connecting to non-temporary websockets, always undefined
Example:
undefined
guildedClientId
string 
optional
The client ID
deviceType
string 
optional
Example:
web
teamId
string 
optional
The team ID if connecting to a websocket for team-specific events
Modified at 2024-06-10 20:39:03
Previous
Get Featured Tournaments
Built with