Glossary
| Term | Meaning |
|---|---|
| Tenant | Your organization’s account with Growth Engine, the unit of isolation. Owns API keys, branding, and every record. |
| User | A person you register (via the API) so they can use the GUI. Identified by an Engine id and your own tenantKey. Managed by you; the Engine stores no passwords or roles. |
tenantKey | Your identifier for a user (their id in your system), unique within your tenant. |
| Session token | Short-lived, single-use token your backend mints for one of your users; the GUI exchanges it for a session cookie. |
| Verified address | An email/phone the Engine has confirmed via its own link/code challenge. The Engine only sends to verified addresses. |
| Flow | A monitoring algorithm: a grid of tiles + settings + the Sources it is bound to + alert/report configuration. |
| Tile | One step in a Flow. Every tile is a database-defined record (parameters schema + runtime script in TS/JS or Python). Built-in: gdd, ch, bv, wv, acc, tw, se; tenants can add their own; see Tiles. |
| Source | The one generic data source a flow can be bound to and run against. You register it with a displayName, a hint saying what it is (well-known: area (a monitored geography), sensor (a device/station that produces readings), weather-station; any other hint is accepted and listed too), an optional sensorType (same-type sensors inside an area are averaged), an optional stable tenantKey, an optional GeoJSON boundary, an optional location (lat/lng), a timezone and free metadata. The GUI Sources step lists the catalog grouped by hint and can add, edit, disable, or delete records (including list-only sources with no geometry). |
hint | An open string on a Source that tells clients what kind of source it is. Unknown hints still work; the well-known ones get dedicated rendering in the GUI. |
| Target | A Source a flow is bound to, at run time (sourceId, hint, name, lat/lng, timezone). |
| Run | One execution of a flow against one target; yields trigger points, probability and color. |
| Contact | An alert/report recipient (name + verified email/phone), organized in contact lists. |
| Report | A frozen snapshot of a run’s results, shared by a 7-day link (Reports). Scheduled per flow (settings.reports, time or event mode) or sent on demand; the Engine emails the link, the GUI renders the page. |
| Brand | {name, logo, skin}: your organization’s identity in the GUI. Tenant-first; users with canOverrideBranding may set a personal brand for their own account, resolved per-field over the tenant’s (Branding). |
| Adapter | Your connector: a script (TS/JS; Python planned) + write-only env + egress allow-list, run in the Engine’s sandbox to supply readings, forecasts and events at run time (the Engine stores none of that data), or (the comms facet) to send alert/report messages through your own provider. One adapter per facet. |
| Webhook | A signed HTTPS notification the Engine sends to your endpoint when something happens. |