Lumi/knowledge/plugins/welcome-messages.md
2026-06-25 14:10:04 +02:00

115 lines
5.6 KiB
Markdown

---
id: plugin.welcome_messages
title: Welcome Messages
scope: plugins
status: active
priority: 10
visibility: user
category: Plugin
tags: plugin, welcome_messages
generated: true
editable: false
updated_at: "2026-06-25T12:06:11.231Z"
---
# Welcome Messages
Randomized Discord welcome and welcome-back messages with safe pronoun preferences.
## Metadata
Plugin ID: welcome_messages
Version: 0.1.0
Default state: enabled
## Web Routes
- /plugins/welcome_messages
- GET /plugins/welcome_messages
- POST /plugins/welcome_messages/settings
- POST /plugins/welcome_messages/messages/create
- POST /plugins/welcome_messages/messages/:id/update
- POST /plugins/welcome_messages/messages/:id/duplicate
- POST /plugins/welcome_messages/messages/:id/archive
- POST /plugins/welcome_messages/messages/:id/restore
- POST /plugins/welcome_messages/profile/pronouns
## Route Reference
### MOUNT /plugins/welcome_messages
- Purpose: Mounts the plugin router at this base WebUI path.
- Inputs: No request parameters detected by static analysis.
- Response format: Plugin router mount point.
- Access: Access is controlled by the mount options and individual plugin routes.
- Side effects: No direct route action; child routes handle requests.
- Limits/notes: Mount metadata is inferred from static source scanning.
### GET /plugins/welcome_messages
- Purpose: Renders or serves the welcome_messages plugin page.
- Inputs: No request parameters detected by static analysis.
- Response format: HTML page rendered from an EJS view
- Access: admin access expected; logged-in session required or used
- Side effects: Usually read-only.
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations.
### POST /plugins/welcome_messages/settings
- Purpose: Processes the welcome_messages plugin action for settings.
- Inputs: body: `channel_id`, `enabled`, `welcome_back_enabled`
- Response format: HTTP redirect after handling the request
- Access: admin access expected; logged-in session required or used
- Side effects: writes or mutates server-side state
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
### POST /plugins/welcome_messages/messages/create
- Purpose: Processes the welcome_messages plugin action for messages create.
- Inputs: body: `enabled`, `pool`, `text`
- Response format: HTTP redirect after handling the request
- Access: logged-in session required or used
- Side effects: writes or mutates server-side state
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
### POST /plugins/welcome_messages/messages/:id/update
- Purpose: Processes the welcome_messages plugin action for messages id update.
- Inputs: path params: `id`; body: `enabled`, `pool`, `text`
- Response format: HTTP redirect after handling the request
- Access: logged-in session required or used
- Side effects: writes or mutates server-side state
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
### POST /plugins/welcome_messages/messages/:id/duplicate
- Purpose: Processes the welcome_messages plugin action for messages id duplicate.
- Inputs: path params: `id`; body: `pool`
- Response format: HTTP redirect after handling the request
- Access: logged-in session required or used
- Side effects: writes or mutates server-side state
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
### POST /plugins/welcome_messages/messages/:id/archive
- Purpose: Processes the welcome_messages plugin action for messages id archive.
- Inputs: path params: `id`; body: `pool`
- Response format: HTTP redirect after handling the request
- Access: logged-in session required or used
- Side effects: writes or mutates server-side state
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
### POST /plugins/welcome_messages/messages/:id/restore
- Purpose: Processes the welcome_messages plugin action for messages id restore.
- Inputs: path params: `id`; body: `pool`
- Response format: HTTP redirect after handling the request
- Access: logged-in session required or used
- Side effects: writes or mutates server-side state
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
### POST /plugins/welcome_messages/profile/pronouns
- Purpose: Processes the welcome_messages plugin action for profile pronouns.
- Inputs: body: `pronoun_set`
- Response format: HTTP redirect after handling the request
- Access: logged-in session required or used
- Side effects: writes or mutates server-side state
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Most non-API POST routes are browser form submissions and usually redirect after completion.
## Commands
- No plugin command triggers detected.
## Source
Plugin folder: plugins/welcome_messages