Workflows

Workflow commands enable you to manage workflows in your Knock account from the CLI.

When workflows are pulled from Knock, they are stored in directories named by their workflow key. In addition to a workflow.json file that describes all of a given workflow's steps, each workflow directory also contains individual folders for each of the channel steps in the workflow that hold additional content and formatting data.

workflows/
└── my-workflow/
  ├── email_1/
  │   ├── visual_blocks/
  │   │   └── 1.content.md
  │   └── visual_blocks.json
  ├── in_app_feed_1/
  │   └── markdown_body.md
  └── workflow.json

If you're migrating your local workflow files into Knock, you can arrange them using the example file structure above and then push them into Knock with a single command using knock workflow push --all. Each workflow.json file should follow the structure defined here.

You can see all your existing workflows in a given environment with the workflow list command.

Use an --environment flag to specify the target environment; if omitted, the Knock CLI defaults to the development environment.

Flags

You can show more details about a given workflow with the workflow get command, followed by the target workflow key.

Use an --environment flag to specify the target environment; if omitted, the Knock CLI defaults to the development environment.

Flags

Create a new workflow with a minimal configuration. You can either select steps interactively or use a template to scaffold the workflow.

The command will create a new workflow directory in your local file system. By default, this will be in the workflows resource directory set by your knock.json file, or the current working directory if not configured.

Flags

You can pull and download workflows with its message templates from Knock to a local file system with the workflow pull command. Knock CLI will create a new workflow directory or update the existing workflow directory in the local file system.

By default this command will resolve to the workflows resource directory via your knock.json file. When not set, will use the current working directory as the default. In the case of the --all flag, the target directory path will be resolved via your knock.json file or the --workflows-dir flag.

Note: if pulling the target workflow for the first time (or all workflows), Knock CLI will ask to confirm before writing to the local file system.

See the Workflow file structure section for details on how workflow files are organized.

Flags

You can push and upload a workflow directory to Knock with the workflow push command. Knock will update an existing workflow by the matching workflow key, or create a new workflow if it does not exist yet.

By default this command will resolve to the workflows resource directory via your knock.json file. When not set, will use the current working directory as the default. In the case of the --all flag, the target directory path will be resolved via your knock.json file or the --workflows-dir flag.

Note:

• The workflow push command only pushes workflows into the development environment.
• You must be directly above the target workflow directory when running the workflow push command, so the CLI can locate the workflow.json file.
• You can also pass in the --commit flag (with an optional --commit-message flag) to commit the upserted changes immediately.

See the Workflow file structure section for details on how workflow files are organized.

Flags

You can run a workflow with the workflow run command. Knock will execute a run for the latest saved version of the workflow it finds with the given key and parameters you send it.

Note:

• Changes to the local version of the workflow in your file system will not be reflected in a workflow run; it will use the current version that is stored in Knock.

Flags

You can validate a new or updated workflow directory with the workflow validate command. Knock will validate the given workflow payload in the same way as it would with the workflow push command, except without persisting those changes.

Note: Validating a workflow is only done against the development environment.

Flags

You can activate or deactivate a workflow in a given environment with the workflow activate command.

Note:

• This immediately enables or disables a workflow in a given environment without needing to go through environment promotion.
• By default, this command activates a given workflow. Pass in the --status flag with false in order to deactivate it.

Flags

Generate type definitions for workflow trigger data from your workflow schemas. This command fetches workflows with trigger data schemas and generates type-safe definitions for TypeScript, Python, Ruby, and Go.

The generated types enable compile-time safety when triggering workflows in your application code, helping catch integration errors before runtime. The target language is inferred from the output file extension.

Learn more about type safety with workflows.

Flags