Environments

How It Works

Environment variables are a centralized way to manage configuration that's shared across multiple HookWatch services. Unlike Cron Secrets which are specific to cron jobs, environment variables can be scoped to any service.

1. Create a variable with a key, value, scope, and optional description
2. Secret values are encrypted with AES-256; non-secret values are stored as-is
3. Reference the variable in templates using {{env.KEY_NAME}}
4. At runtime, variables are resolved based on the service scope

Service Scopes

Control where each variable is available by setting its scope:

Template Syntax

Reference environment variables using the {{env.KEY}} syntax in any supported template field:

Secret vs Plain Values

Variables can be marked as secret or plain:

The Environment Variable Object

Values are never included in API responses. Only the key, scope, and metadata are returned.

Create Variable

Create a new environment variable.

Request Body

Example

List Variables

Retrieve all environment variables for the authenticated user.

Response

Get Variable

Retrieve a specific environment variable by ID.

Update Variable

Update a variable's value, description, or scope. The key is immutable.

Request Body

Delete Variable

Permanently delete an environment variable.