Uh oh! We couldn’t find any match.
Please try other search keywords.
There are two ways to store configuration information for your capsules, such as endpoint URIs, API keys, permission scopes, environment modes, or any other configuration data that you'd like to be able to change without editing capsule code:
capsule.propertiesfile within your capsule itself.
Secrets are sensitive information that should not be stored in code and might need to be updated frequently, such as API keys or other authentication details. By entering these in the Secrets section of the Bixby Developer Center, they will be securely encrypted end-to-end, and will even appear obfuscated in the Developer Center's UI. Secrets can be updated at any time.
Static, non-sensitive information that isn't likely to change often should be defined in the
capsule.properties file. This could include endpoint URIs, permission scopes, and feature gates.
By setting dynamic properties in the Config section of the Bixby Developer Center, you can change property values without editing capsule code. If you define capsule properties in the Developer Center with the same names as properties in the
capsule.properties file, the dynamic values will override the static ones in the file. Delete these dynamic properties to return to the values defined in the file.
capsule.properties file to store configuration properties related to your capsule, such as endpoints, scopes, or whether to use test or production configuration properties. This file is for properties that you don't expect to change very often, if at all. Properties that are likely to change should be handled through the Config & Secrets screen of the Bixby Developer Center. (You can override any property defined in this file by entering a new value for it in the Config screen.)
This file use a simple INI-like format:
API keys, passwords, and other sensitive information must be entered and managed through the Secrets section of the Config & Secrets page. They must never be stored in the
You can set the configuration mode for your capsule using
You can set properties for specific configuration modes, which are helpful when you want to use your capsule in different environments.
You can set properties for each mode using this format:
default mode for any fallback property values:
Capsule properties are treated as strings, so ensure that you cast them to right type.
Do not include empty strings, as they are then surrounded by quotes (
You can toggle individual capsule properties using this format:
You can toggle content from a capsule using this format:
To set configuration properties and secrets dynamically through the web interface:
Select the capsule for which you want to edit configuration values or secrets.
Click the + Add button to add a new key/value pair to either the Configuration section or the Secrets section. This will display fields to enter a new name and value; click Add on the new field to save it.
You can provide different values for properties and secrets in development and production modes by selecting Dev or Prod.
The configuration mode setting in the Config & Secrets UI screen is independent of the configuration mode setting in the
When you make changes, a new set of buttons will appear at the top of the screen.
You can continue to add, update, and delete configuration properties and secrets while these buttons are displayed.
When Bixby looks for a property value, it follows this precedence:
defaultconfiguration mode in
For example, if you define
config.sport=baseball in the properties file and then use the Config & Secrets screen to set
baseball. The definition in the UI screen has a higher precedence than the definition in
var value = config.get('key');
Secrets and configuration properties are entirely separate from each other:
secret.get('key') can yield different values. The configuration property named
key and the secret named
key are separate.