Brands

Brands let you tailor access, environments and features across different entities within your organization, such as different mastheads, regional editions, or product lines.

This functionality is off by default. To enable it, navigate to Settings in the left-hand navigation menu, select the Brands tab, then click 'Enable Brands'.

A modal will pop up, explaining that enabling brands is a permanent action and cannot be undone. To continue, click ‘Enable Brands’, otherwise click ‘Cancel’.

Configure a Brand

Once enabled, you’ll be taken to the brands lander page, where you’ll see a default brand, named using your organization name.

To add a new brand, click ‘Add Brand’.

You’ll be prompted to give the brand a name, initials, and optional description.

Once done, click ‘Create Brand’.

Manage a Brand

To edit a brand, navigate to Settings, select the Brands tab, locate the brand in your brands list, then click the 'Edit' icon in the actions column.

The brand management area includes two tabs: Variables & Secrets, and Manage.

The Variables & Secrets tab allows you to define key-value pairs at the brand level that can be consumed in workflows across all environments for this brand, enabling you to separate configuration from logic.

Variables defined here will apply to all workflows running in this brand across all environments unless overridden by variables set at the environment type or brand-environment level.

Variables are useful for storing brand-specific configuration values like brand-specific API endpoints, feature flags, or other settings that apply to this brand. Secrets are a special type of variable designed for sensitive data like API keys, where the value cannot be viewed once saved.

Creating Variables & Secrets

To add a variable or secret, click 'Add Variable'.

You'll need to provide:

Key: The variable name (must start with a letter or underscore, contain only alphanumeric characters and underscores, maximum 64 characters)
Value: The variable content (stored as text)
Secret: Toggle this on to mark the variable as a secret

When you're ready to save, you can choose:

Save: Save the variable and return to the list
Save and Add Another: Save the variable and immediately create another one
Cancel: Discard changes and return to the list

Variable Precedence

Variables defined at the brand level will override organization-level variables with the same key, but will be overridden by variables set at the environment type or brand-environment level.

Using Variables in Workflows

Variables and secrets are accessible in workflows through the env parameter:

export default ({ env }) => {
  console.log(env.SERVICE_URL);

  // Use variables for configuration
  const apiEndpoint = env.API_ENDPOINT;
  const secretKey = env.SECRET_API_KEY;
};

All variables are provided as strings and may be undefined if not set at any level. For example, when the variable is set for a different environment than the current event, or the variable a set for a different brand than the current event.

Security Considerations

Secrets are designed for sensitive data:

Values cannot be viewed in the console once saved
Values are not accessible via the admin API
Use secrets for API keys, passwords, and other sensitive configuration

Variables are for non-sensitive configuration:

Values are visible in the console
Use for API endpoints, feature flags, and other non-sensitive settings

Please note: Ensure you use the secret toggle for any sensitive data like API keys or passwords.

Managing Variables & Secrets

To edit a variable or secret, locate it in your variables & secrets list, then click the 'Edit' icon in the actions column.

This will bring up the same screen you used to configure your variable. Make any relevant changes and click 'Save'.

To delete a variable or secret, locate it in your variables & secrets list, then click the 'Delete' icon in the actions column.

You will be prompted to confirm you wish to remove the variable. This action cannot be undone.

To continue, click 'Delete'. Otherwise, click 'Cancel'.

When updating a variable, the change will propagate to all relevant environments automatically.

Manage

The Manage tab allows you to edit the name, initials, and description of your brand.

Once done, click 'Update'.

You can also choose to delete your brand by clicking the 'Delete' button. A modal will display warning you that this action cannot be undone. To continue, click 'Delete'. Otherwise, click 'Cancel'.

When brands are configured, a new menu will appear in the top right corner of your screen.

This is the brands filter. It allows you to see an overview of all brands at once, or filter to a specific brand.

When a brand filter is in place, all configuration and data seen within the console will be specific to that brand. For example, you will only see observability data for calls made against that brand.

Brand Tagging

Using the brands feature in MonetizationOS allows you to create configuration that is specific to a singular or multiple brands. This includes assigning specific brands to:

Click the relevant link above to learn more.