commands - trigger

​

Prerequisites

• Have a Heex CLI
• Have a USER_SECRET_KEY. Should be accessible in your personnal space on the heex cloud platform.

​

Usage

Usage:

./heex trigger SUBCOMMAND [--help]

​

How to create a new trigger

2 different ways to create a new trigger on the cloud, both using the command new:

• [Recommended]: create an trigger only by name and some optional flags:
  • --name: Must be unique on your cloud workspace.
  • --description: Description for your trigger.
  • --middleware: System middleware. Check help for available middleware.
  • --system-category: System category. Check help for available templates.

Usage:

./heex trigger new --api-key <USER_SECRET_KEY> --name "Jane's trigger" --description "Optional description" --middleware 1 --trigger-category 1

• [Advanced]: Another way to create a trigger is to use a configuration file that contains all the data you want to generate. This is still a beta feature under progress, so it is not recommended, but if you want to use it:
  • you can generate a template file using the ./heex trigger create-template-file command, and then fill the given file as you need.
  • Once it is filled, use the create subcommand with the --input-file input pointing to the filled file

Usage:

./heex trigger new --api-key <USER_SECRET_KEY> --input-file path/to/your/filledConfigFile.json

⚠️ Warning:

trigger name or description with special characters If your trigger name or description contains special characters (i.e ’ or space), please use double quotes before and after your names.

For example, for a trigger called Jane’s trigger, provide that as —name “Jane’s trigger”.

​

Getting Help

./heex trigger --help
./heex trigger new --help
./heex trigger create-template-file --help