Guides

Build a workflow

Create an automation from a trigger and steps across Tracee and connected apps, test it, and hand it over.

A workflow is a trigger (a schedule, a published post, a new CRM contact…) followed by steps in Tracee and connected apps. Workflows you create are drafts: a person reviews, publishes and turns them on from the link in the answer.

Find triggers and steps

tracee workflows catalog                 # every trigger and action, with inputs
tracee workflows catalog --app slack     # one app's steps in full

Describe it

weekly.json

{
  "name": "Weekly launch digest",
  "trigger": { "piece": "schedule", "trigger": "every_week", "input": { "day_of_week": 1, "hour_of_the_day": 9 } },
  "steps": [
    { "key": "pick", "piece": "tracee", "action": "pick_posts", "input": { "limit": 3 } },
    {
      "key": "notify",
      "piece": "slack",
      "action": "send_message",
      "input": { "channel": "#marketing", "text": "This week's posts: {{pick.output.posts}}" }
    }
  ]
}

Give steps a key and read their output later as {{key.output.field}}. Steps can also be a router (branches by condition) or a loop.

Create and test it
```
tracee workflows create --data @weekly.json
tracee workflows test <workflow_id>
```
The test runs with sample data; steps that write to other apps or publish are simulated. The answer lists anything still missing.