Skip to main content

Discord

Discord bot settings, connection status, and test payload.

DiscordSettingsController​

  • Route prefix: api/settings/discord
  • Auth: All endpoints require admin role.
MethodPathDescriptionRequestResponse
GET/Current Discord settings (bot token masked){ enabled, botToken (masked), chatBridgeEnabled, chatBridgeChannelId, eventNotificationsEnabled, eventChannelId, notifyPlayerJoin, notifyPlayerLeave, notifyServerStart, notifyServerStop, notifyBloodMoon, slashCommandsEnabled, serverName, showPlayerCountInStatus }
PUT/Update Discord settingsSame shape as GET, with botToken in plaintextstring
GET/statusBot connection status{ isConnected, botUsername, latencyMs }
POST/testSend a test embed to the configured event channelstring

Notes​

  • The botToken field is returned masked on GET (to avoid leaking it back to someone inspecting the response). A PUT expects the plaintext token.
  • slashCommandsEnabled toggles a registration call on bot startup. Discord caches command registration up to an hour, so command changes may take a while to appear.
  • POST /test is a quick way to verify the bot has permissions to post in the event channel without waiting for a real event.

See also: Configuration → Discord Integration for setup walkthrough.