Websocket
wss://www.guilded.gg/ws/
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
astrue
andprefix
asdeep-search-
.
Request
Query Params
temporary
boolean
optional
Used for deep search connections
prefix
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 3 months ago