Tenant Environments
Each tenant has one or more environments. Data is isolated per environment.
What are environments
Environments partition a tenant's data. A tenant might have development, staging, and production—each with its own expected transactions, incoming transactions, matches, data sources, webhooks, and jobs. Use environments to separate dev/test from live data.
Environment values
| Value | Typical use |
|---|---|
| development | Local or dev testing |
| staging | Pre-production, UAT |
| production | Live data |
| test | Automated tests (E2E, integration) |
These are the only valid values. Each tenant can have at most one record per value (unique per tenant).
Adding environments
When you create a tenant, you typically add at least one environment. Use POST /tenants/:id/environments with environment: "production" (or another value). Add more as needed—e.g. add staging before going live.
Settings are created per environment when you first call PATCH /tenants/:id/settings for that environment. Default settings (matching threshold, locale, etc.) are applied.
API usage
Every API request (except health and auth) must include:
X-Tenant-Id— Tenant UUIDX-Environment— One ofdevelopment,staging,production,test
The API validates that the tenant has that environment. If not, the request fails.
API Reference
For full parameter definitions and request/response samples:
- List environments —
GET /tenants/:id/environments - Create environment —
POST /tenants/:id/environments