Skip to main content

What are deployment parameters?

Deployment parameters are values that users configure once when they install a process. Unlike trigger inputs (which change per execution), deployment parameters are baked into the workflow at deployment time. Examples:
  • Company name to include in reports
  • Slack channel ID to post notifications to
  • Maximum number of items to process
  • API endpoint URLs for external services

How it works

Defining parameters in config.ts

getDeploymentInputSchema()

getDefaultDeploymentParameters()

Provides default values for automated installations (no user interaction):

Using INSTPARM in workflows

In Code nodes

INSTPARM placeholders are context-aware — they serialize correctly based on the value type. Do not add extra quotes.
At deployment time, these become:

In node parameters (expressions)

In HTTP request bodies

Field types

All 11 field types from the Input Schema reference are available:

Validation

The CLI checks INSTPARM usage via:

Version updates

When a process is updated to a new version, existing deployment parameters are preserved. New parameters use their default values. Removed parameters are ignored.