Automation file format

Workflow files live under .konvio/automations/ and use YAML (preferred) or JSON.

Top-level fields

FieldRequiredDescription
nameyesDisplay name
descriptionnoShort summary
enablednoDefaults to true
on / triggeryesEvent type(s), shortcuts, or object with filters
stepsyesOrdered list of steps

Triggers

Shortcuts expand to Konvio event ids:

ShortcutEvent
manualautomation.manual
workflow_rungithub.workflow_run.completed
pipeline / pipeline_completedgitlab.pipeline.completed
pushgithub.push
pull_requestGitHub PR opened + synchronize
issuesgithub.issue.created
work_itemProjects work item created / status changed

You can also set the full event id (for example github.workflow_run.completed).

Filters and manual inputs

on:
  workflow_run:
    conclusion: [failure]
    branches: [main]
    workflows: [CI]
on:
  manual:
    inputs:
      environment:
        type: choice
        options: [staging, production]
        default: staging
        description: Target environment

Steps

Supported type values:

  • check — expression gate; optional then / else
  • agent — run an application agent with a prompt
  • commands — shell commands in a sandbox
  • notify — in-app notification

Each step may include an id for {{steps.<id>.*}} variables.

Minimal example

name: Smoke check
enabled: true
on:
  manual:
    inputs: {}
steps:
  - id: notify
    type: notify
    title: Smoke check
    body: Managed automation source is ready.