Collection module settings
Configure a collection module's .root-config.json file, host, runtime stack, settings, manual transactions, and authentication file.
Collection module settings
A collection module's identity and platform settings live in .root-config.json, in the root of the collection_module/ folder. A typical file looks like this:
{
"collectionModuleKey": "my_unique_key",
"collectionModuleName": "My Collection Module",
"organizationId": "1ded9b9b-7729-4e16-8536-ffccf18168b1",
"host": "api.rootplatform.com",
"stack": "root-node-20",
"settings": {},
"manualTransactions": []
}| Property | Definition |
|---|---|
collectionModuleKey | String. The unique key used to identify your collection module across Root. To link this collection module to a product module, add this key under collectionModules in the product module's .root-config.json. |
collectionModuleName | String. The display name of your collection module. |
organizationId | String. The UUID of the organisation that owns the collection module. |
host | String. The Root API host for your tenant. See Hosts below for the full matrix. If you have questions, contact [email protected]. |
stack | String. The runtime stack the module executes on, for example root-node-20. |
settings | Object, optional. Module-level settings. Currently supports legacyCodeExecution (boolean) for modules that need the older execution path. |
manualTransactions | Array, optional. Declares manual transactions exposed by this module. Each entry has key, functionName, and an optional displayData map. Each entry must have a matching JSON file under workflows/manual-transactions/. |
Hosts
Set host to the Root API host for your environment and region:
| Environment | South Africa | United Kingdom |
|---|---|---|
| Production | api.rootplatform.com | api.uk.rootplatform.com |
| Sandbox | sandbox.rootplatform.com | sandbox.uk.rootplatform.com |
Use the sandbox host for local development and the production host only when intentionally operating against production.
Companion file: .root-auth
.root-authThe companion .root-auth file holds the API key the CLI uses to authenticate against host. It's created automatically by rp clone -cm and excluded from git via .gitignore. See File and folder structure for details.
Related guides
- File and folder structure — what each file in a collection module is for.
- Collection module environments — sandbox vs production behaviour.
- Linking a collection module to a product module — wire your collection module into a product.
- Workbench CLI commands —
rp clone -cm,rp pull,rp push,rp publish, and friends.
Updated 8 days ago
What’s Next