@helyx/module-faq
v1.0.8
Published
Create reusable server answers with exact text triggers.
Readme
@helyx/module-faq
FAQ lets a Discord server publish reusable answers that members retrieve with exact faq- message triggers.
Availability and deployment
FAQ is Live and supported by Hosted Helyx and Helyx Self-Hosted. Installation does not enable it for a server, and the module uses no external provider credentials.
What it does
Managers create up to 100 server-scoped FAQs with a question, answer, exact trigger and optional HTTP or HTTPS link. An enabled entry can respond as an embed or plain Components V2 message, optionally mention one explicitly parsed target member, and delete the source trigger only after the response is delivered. FAQ does not perform semantic search or answer messages that do not use an exact configured trigger.
Commands and interactions
| Path | Default access | Purpose |
| ------------- | -------------- | ------------------------------------------ |
| /faq create | Moderator | Open the form for a new FAQ. |
| /faq edit | Moderator | Search for and edit an existing FAQ. |
| /faq delete | Moderator | Search for and confirm permanent deletion. |
| /faq list | Moderator | Privately review all retained FAQs. |
Members retrieve an enabled entry by sending its exact faq- trigger. Each slash-command path has an independent permission override. Dashboard FAQ management continues to use the separate faq.manage resource permission.
Dashboard configuration
FAQ has no module settings. Managers use the FAQs resource workspace to search, filter, preview, create, edit, enable, disable and delete entries. Revision checks reject stale edits, and validation prevents duplicate triggers or a 101st retained entry.
Discord requirements
Helyx requires the Message Content intent to recognize triggers. It needs View Channel, Send Messages and Embed Links where responses are used, plus Manage Messages only when an FAQ is configured to delete its source trigger.
Data, privacy and retention
Each entry retains its server ID, question, answer, trigger, optional link, presentation and behavior settings, revision, timestamps, and nullable creator and last-editor Discord user IDs until a manager deletes it. Privacy access includes matching records; erasure can detach creator and editor IDs, while customer-written content that may identify somebody is flagged for manual review. Triggering member messages and autocomplete searches are not copied into FAQ records.
Operations and failure behavior
Trigger lookups use a bounded cache of at most 500 servers and 100 enabled entries per server, with a 30-second maximum local age. Member and server rate limits bound message-trigger delivery. Failed storage, response delivery, source deletion or cache invalidation is reported through module health using safe fixed messages; successful recovery clears the active failure. Disabling FAQ stops commands and trigger handling while preserving retained entries and privacy coverage.
Documentation and support
See the FAQ guide, commands, permissions, and FAQ troubleshooting.
