Configuration values
Named values the application needs but must not contain — API keys, account numbers, thresholds.
Settings › Configuration. A name and a value. The application reads the value; the value is never written into the code.
What belongs here#
- An API key for a service the application calls.
- An account number, a tenant id, a webhook address.
- A threshold or a limit somebody will want to change without a build — how many days before a visit counts as overdue.
- Anything that differs between test and live.
Per environment#
Every value can apply to every environment, or only to live, or only to test.
A name with no value yet#
You can save a name on its own. That is not an unfinished entry — it is how an application says what it still needs.
It is mostly how the builder asks you for a credential. A value typed into the conversation stays in that conversation, so rather than ask you to paste a key there, it creates the name and tells you it is waiting. The Configuration section then lists it as no value yet, with a note saying what it is for. Press Replace to put the value in.
Until you do, the application reads that name as empty. Code written against it does not fall over on a setting that is not there; whatever it calls does not work yet, which is usually the clearer of the two failures.
When it takes effect#
An application reads its configuration when it starts, so saving a value does not reach anything that is already running.
- Test and live get it at their next deployment.
- The preview gets it when you press Restart the preview — in the application menu, and offered to you in Settings the moment you save something.
The workbench asks whether you want to restart, rather than doing it for you: the preview goes down for about a minute, and somebody setting five values in a row does not want five restarts. Nothing is lost when it does — the code, the installed packages and the preview's own records all stay exactly as they are.
You can also ask for it in the conversation: restart the preview so it picks up the key.
Secrets#
A value marked as a secret is encrypted at rest and read back only as a hint. Once saved it can be replaced but never re-read.
That is deliberate. A settings screen that hands back everybody's API keys is a worse leak than the one it prevents. If you need the value again, get it from wherever it came from.
What the builder is told#
The names, so it can write code that reads them — and which of them are still waiting for a value. Never the values themselves.
A value in a prompt is a value in a transcript, so a real credential typed into the conversation stays in that conversation. Put it here instead — the builder will tell you to.
In the conversation: Use the Stripe key in configuration called
STRIPE_SECRET_KEYto create the charge.Not in the conversation: Use this key:
sk_live_…
If the name does not exist yet, ask for it to be created and leave it empty —
add a configuration value called STRIPE_SECRET_KEY for the live key. It
appears here waiting for you.
Reserved names#
A few names are the platform's and cannot be overridden — the database address, the storage credentials, the platform token. An application overriding one would be reaching for another tenant's database, so the attempt is refused.
You will be told if you pick one.
Integrations set their own#
Connecting an integration fills in the right names automatically. You do not add an email provider's key here by hand; you connect the provider.
Anything not in the catalogue is added here as an ordinary value.