Skip to main content
AKOS

Triggers

Add, list, remove, and test flow triggers from the command line, and browse built-in trigger presets.

Triggers define when and how a flow starts: on a schedule, in response to a webhook, when a file appears, or on a platform event. The triggers and trigger preset commands manage triggers in your workspace config and interact with the running sidecar.

Listing trigger kinds

To see all supported trigger kinds and their required parameters:

akos triggers kinds

Listing triggers in a config

akos triggers list

By default this reads akos.config.yaml in the current directory. Pass a different path with --config <path>.

Adding a trigger

akos triggers add \
  --flow <flow-id> \
  --kind <kind> \
  [kind-specific options]

For example, to add a cron trigger that fires every day at 09:00:

akos triggers add \
  --flow daily-report \
  --kind cron \
  --cron "0 9 * * *"

To add an inbound webhook trigger:

akos triggers add \
  --flow inbound-webhook \
  --kind webhook

Check akos triggers add --help for the full list of kind-specific flags.

Removing a trigger

akos triggers remove <trigger-id>

Pass --config <path> to target a specific config file.

Testing a trigger

Sends a synthetic event through the sidecar to verify a trigger is wired correctly:

akos triggers test <trigger-id>

Viewing trigger run history

List recent executions for a trigger:

akos triggers runs <trigger-id>

Getting the inbound URL for a webhook trigger

akos triggers url <trigger-id>

Prints the inbound URL that external systems should POST to.

Enabling or disabling a trigger

# Disable a trigger
akos triggers toggle <trigger-id> --disable
 
# Re-enable it
akos triggers toggle <trigger-id> --enable

Listing trigger contracts

To list every registered trigger contract (the trigger kinds the sidecar knows how to dispatch) via the running sidecar:

akos triggers contracts

Add --json for structured output. This requires the sidecar (akos serve).


Trigger presets

AKOS ships curated trigger presets — ready-to-copy configurations for common scenarios. Presets are read-only reference material; use them as a starting point when adding triggers.

List presets

akos trigger preset list

Output as JSON:

akos trigger preset list --json

Show a preset

akos trigger preset show webhook/inbound-generic

The command prints the preset's title, description, and the full trigger configuration block you can copy into your config.

Output as JSON:

akos trigger preset show webhook/inbound-generic --json

Making your workspace reachable for webhooks

By default the sidecar binds its webhook listener to 127.0.0.1 (loopback only). To receive webhooks from external systems, start the sidecar with --public:

akos serve --public

Pin the webhook port:

akos serve --public --webhook-port 4242

When --public is used, the CLI prints a security warning. Run behind a firewall or trusted tunnel and ensure every webhook trigger verifies its signature.

Triggers · AKOS