Triggers

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:

agentskit-os triggers kinds

Listing triggers in a config

agentskit-os triggers list

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

Adding a trigger

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

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

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

To add an inbound webhook trigger:

agentskit-os triggers add \
  --flow inbound-webhook \
  --kind webhook

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

Removing a trigger

agentskit-os 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:

agentskit-os triggers test <trigger-id>

Viewing trigger run history

List recent executions for a trigger:

agentskit-os triggers runs <trigger-id>

Getting the inbound URL for a webhook trigger

agentskit-os triggers url <trigger-id>

Prints the inbound URL that external systems should POST to.

Enabling or disabling a trigger

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

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

agentskit-os trigger preset list

Output as JSON:

agentskit-os trigger preset list --json

Show a preset

agentskit-os 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:

agentskit-os 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:

agentskit-os serve --public

Pin the webhook port:

agentskit-os 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.