EnvironmentVariable

An organization environment variable. Reference it from an action field with the `reference` token; the value is substituted per row when the workflow runs. Values are never returned by the API.

Properties

keystringrequired

Canonical identifier, unique within the organization and immutable once created. This is the segment used in the reference token.

namestringrequired

Display name shown in the Floqer app. Editable, so never reference a variable by it.

descriptionnull | stringrequired

Optional free-text description set by the org. `null` when unset.

scopestringrequired

Which axis the value varies along. `org` — one value for the whole organization. `workflow` — one value per workflow, so the variable only resolves in workflows that have one set. `user` — one value per member, resolved against the workflow's OWNER (not whoever triggers the run).

"org""workflow""user"

referencestringrequired

Ready-to-paste reference token. Use it as (or inside) any string value in Configure Action's `inputs`.

value_countintegerrequired

How many scope points currently have a value: 1 or 0 for `org` scope, and for `workflow` / `user` scope the number of workflows / members with one set. `0` means the variable resolves nowhere yet.

created_bynull | stringrequired

Email of the member who created the variable. `null` on older rows.

updated_atstring <date-time>required

UTC timestamp (ISO 8601) the definition was last changed. Setting a value does not change it.

Example

EnvironmentVariable example

{
  "key": "string",
  "name": "string",
  "description": null,
  "scope": "org",
  "reference": "{{env.api_base}}",
  "value_count": 0,
  "created_by": null,
  "updated_at": "1970-01-01T00:00:00.000Z"
}