Environment variable schema Model API Reference (Environment Variables)
Reference the Novu environment variable schema used in API requests and responses. Review fields, data types, and object structure for this resource.
Environment Variable
Environment variable is a named value you define once in the dashboard and reuse across workflows. Each Novu environment can hold its own value for the same variable, so Development and Production (and any custom environments) stay isolated without duplicating workflow logic. Read more about environment variables on environment variables documentation page.
| Prop | Type | Default |
|---|---|---|
updatedAt? | string | - |
createdAt? | string | - |
values? | EnvironmentVariableValueResponseDto[] | - |
isSecret? | boolean | - |
type? | "string" | - |
key? | string | - |
organizationId? | string | - |
id? | string | - |
Publish resources to target environment POST
Publishes all workflows and resources from the source environment to the target environment. Optionally specify specific resources to publish or use dryRun mode to preview changes.
Create a variable POST
Creates a new environment variable. Keys must be uppercase with underscores only (e.g. BASE_URL). Secret variables are encrypted at rest and masked in API responses.