Getting Started
Create a Flag
Define a feature flag with a key, type, and default value, then toggle it per environment.
Create a flag
- Navigate to your project's Flags page
- Click Create Flag
- Fill in the details:
| Field | Description |
|---|---|
| Name | Human-readable name (e.g. "New Checkout Flow") |
| Key | Unique identifier used in code (e.g. new-checkout-flow). Lowercase letters, numbers, and hyphens only. |
| Type | One of: boolean, string, number, json |
| Default Value | The value returned when no targeting rules match |
| Description | Optional notes about what this flag controls |
Flag types
| Type | Default Value Example | Use Case |
|---|---|---|
| boolean | false | Simple on/off toggles |
| string | "control" | A/B test variants, theme names |
| number | 0 | Rate limits, thresholds |
| json | {"maxItems": 10} | Complex configuration objects |
Per-environment configuration
Flags exist at the project level, but their enabled state and targeting rules are configured independently per environment.
When you first create a flag, it's disabled in all environments. To start evaluating it:
- Go to the flag's detail page
- Select an environment (e.g. Development)
- Toggle the flag on
- Optionally add targeting rules
A flag that's disabled always returns the default value with reason: 'disabled'.
Adding targeting rules
Targeting rules let you return different values based on the evaluation context (user attributes). Rules are evaluated in order — the first match wins.
Each rule has:
- Attribute — the context property to check (e.g.
userId,email,country) - Operator — how to compare (e.g.
equals,contains,in,percent) - Value — what to compare against
- Return Value — the value to return when this rule matches
Example: return true for users where email contains @acme.com:
| Attribute | Operator | Value | Return Value |
|---|---|---|---|
email | contains | @acme.com | true |
See Evaluation Engine for details on all operators, percentage rollouts, and rule ordering.
Next steps
- Connect the SDK — evaluate this flag in your app
- Targeting Rules — detailed guide on the rules UI
- Evaluation Engine — how rules are processed