Parameters let you keep credentials and user-specific settings separate from the rest of an automation config.
Instead of hardcoding a password or account number directly into the config, you define a parameter and reference it elsewhere with {{parameter_name}}.
Simple Example
{
"connection": {
"type": "sftp",
"address": "sftp.vendor.example",
"username": "{{ftp_username}}",
"password": "{{ftp_password}}",
"port": 22
},
"parameters": [
{
"name": "ftp_username",
"value": "",
"label": "FTP Username",
"description": "Your SFTP username"
},
{
"name": "ftp_password",
"value": "",
"label": "FTP Password",
"description": "Your SFTP password",
"encrypted": true
}
]
}
Where Parameters Appear in the UI
- For shared/published automations, parameters are filled during the Configure step of the install wizard
- For custom automations, the Parameters tab becomes useful once you add a top-level parameters section to the config
Common Parameter Properties
| Property | What it does |
|---|---|
| name | The placeholder name used in {{name}} |
| value | The runtime value to inject |
| label | A user-friendly display name |
| description | Help text shown in the UI |
| encrypted | Stores the value securely and uses a password-style input in the UI |
| required | Marks the parameter as required or optional |
| allowed_values | Restricts the user to a fixed set of values |
Allowed Values in the Current UI
Note: In the current UI, allowed_values are rendered as a radio-button choice list, not a dropdown.
{
"parameters": [
{
"name": "feed_mode",
"label": "Feed Mode",
"description": "Choose the inventory feed variant to use",
"allowed_values": [
{ "label": "Full Feed", "value": "full" },
{ "label": "Delta Feed", "value": "delta" }
]
}
]
}
Why Parameters Matter
- They keep secrets out of the visible config
- They make shared automations reusable across multiple accounts
- They let you update account-specific values without rewriting the full automation