Match Labels

Match Labels

Match Labels are a selector mechanism used across RedCarbon to target specific customers. They determine which customers are affected by a given configuration (e.g., an email template or an SLA policy).

How It Works

Each customer can have one or more labels assigned. When a configuration defines match labels, RedCarbon evaluates those labels against each customer's own labels. If they match, the configuration is applied to that customer.

Labels follow a simple key-value format:

key = value

Label Keys

There are two categories of label keys:

Reserved Keys

The id key is reserved and automatically assigned by RedCarbon to every customer. It uniquely identifies a customer and cannot be modified by the tenant.

id = custo_xyz

Use this key when you need to target a specific customer precisely.

Custom Keys

All other key-value pairs are defined freely by the tenant and can represent any organizational grouping that makes sense for your setup.

Examples:

customers = red
integrations = xdr
tier = enterprise
region = emea

Custom labels are set manually on each customer and can be used to group customers by any criteria — product line, integration type, contract tier, and so on.

Setting Match Labels on a Customer

To assign labels to a customer:

  1. Navigate to Organization Admin > Customers.
  2. Find the customer you want to label.
  3. Click set labels next to the customer.
  4. Add labels in key = value format.
  5. Click Save to apply.

Using Match Labels in a Configuration

When configuring a resource that supports match labels (e.g., Email Templates, SLA policies):

  1. Open the configuration you want to target.
  2. Click set match labels.
  3. Enter a label expression matching the intended customers.
  4. Click Save.

If no match labels are set on a configuration, it will not be applied to any customer.

Where Match Labels Are Used

FeatureEffect when matched
Email TemplatesOverrides the organization name shown in emails sent to the customer
SLA ConfigurationApplies a specific SLA policy to the customer