Modbot Docs
APIAPI referenceSettings

Get welcome steps

GET/api/settings/discord-welcome

The steps a new Discord member is sent: whether it is on, where it goes, the rules that pick a step from a role, and the default steps.

Needs the ManageSettings permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/settings/discord-welcome"
{  "enabled": true,  "via": "string",  "channelId": null,  "linkButton": true,  "rules": [    {      "roleId": "string",      "text": "string",      "link": null    }  ],  "defaults": [    {      "text": "string",      "link": null    }  ],  "mostRules": 0,  "mostDefaults": 0,  "mostTextLength": 0}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.