Mod Configuration Options

Mod Configuration Options let developers define customizable settings that can be configured by:

• Mod users, when activating a mod

• Team administrators, when deploying a mod to their organization

These settings are ideal for things like:

• Setting a default language

• Choosing which database to reference

• Enabling or disabling specific features (feature flags)

Once set, the values are passed into the mod at runtime and can be accessed in your mod using @options.variableName.

Defining a Configuration Option

Each option includes:

Field	Description
Name	The variable name used in @options.variableName
Label	Displayed in the form
Field Description	Optional text to provide with instructions for setting the text. Accepts markdown.
Type	Input type (text, dropdown, checkbox, databse selector, Google Sheet, etc.)
Default	Optional starting value
Placeholder	Hint displayed before entering text
Required	Optional flag to require thjis field for activation or deployment.

Example

Then use @options.user anywhere in your mod.

---

Best Practices

• Use clear, human-friendly labels.

• Use dropdowns or checkboxes to guide user input and provide consistency in options.

• Set default values to reduce friction.

• Group related options together when possible.

• Do not use for storing sensitive information, like API keys or secrets.

---

FAQs

What’s the difference between @options and @input? @options refers to configuration values set when the mod is activated or deployed. @input is used to collect information about the current page each time a mod runs.

Can I hide options or values from users? No. All configuration options are visible when the mod is activated or deployed. For this reason, displaying secrets is not advised. Use an Integration to store and process API keys and tokens safely.

Can I update options after deploying a mod? Yes. Users or team admins can update the deployment options at any time.

Do configuration values persist across sessions? Yes. Once set, configuration values persist until updated in the deployment or the mod is reactivated.