Settings

The basic setup and settings of a collection module are defined in the .root-config.json. The .root-config.json should resemble the following:

{  
  "collectionModuleKey": "my_unique_key",  
  "collectionModuleName": "My Collection Module",  
  "organizationId": "1ded9b9b-7729-4e16-8536-ffccf18168b1",  
  "host": "https://sandbox.uk.rootplatform.com", 
}

Property

Definition

collectionModuleKey

  • String_. The unique key used to identify your collection module across Root.

To link a collection module to a collection module, you need to update the .root-config.json in the collection module with this key in the collectionModules section.

collectionModuleName

  • String_. The name of your collection module.

organizationId

  • String_. The UUID of the organisation that owns the collection module.

host

  • String_. For most collection modules, this is "api.rootplatform.com". If you have questions about this property, please contact support at [email protected].