Guild
Definitions
Guild
| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| id | string | guild id |
| name | string? | guild name |
| avatar | string? | guild avatar |
API
Get Guild
POST /guild.get| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
Get a guild by id. Returns a Guild object.
Get Guild List
POST /guild.list| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| next | string | pagination token |
Get guilds where the current user is a member. Returns a paginated list of partial Guild objects.
Handle Guild Invitation
POST /guild.approve| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| message_id | string | request id |
| approve | boolean | whether to approve the request |
| comment | string? | comment |
Handle an invitation from a guild.
Events
guild-added
Triggered when joining a guild. Required resource: guild.
guild-updated
Triggered when a guild is modified. Required resource: guild.
guild-removed
Triggered when leaving a guild. Required resource: guild.
guild-request
Triggered when receiving a new guild invitation. Required resource: guild.