tracee workflows

catalog

Workflow triggers and steps. Every trigger and action with its inputs and an example output. Pass app (e.g. ap_hubspot) for one connected app's steps in full.

tracee workflows catalog [--app <app>]

• --appstring

  One connected app's steps in full, e.g. ap_hubspot

  up to 60 characters

tracee workflows catalog --app slack

list

List workflows.

tracee workflows list

create

Create a workflow draft. A trigger and steps, saved as a draft; a person publishes and turns it on from the link in the answer. Give steps a key to read their output later as {{key.output.field}}.

tracee workflows create --name <name> --trigger <trigger> --steps <steps>

• --namestringrequired

  1–80 characters

• --triggerobjectrequired

  JSON text or @file.json.

  Show child attributes
• --stepsobject[]required

  Run in order JSON text or @file.json.

  up to 25 items

  Show child attributes

--data <json|@file|-> sends the whole body instead of flags.

tracee workflows create --data @flow.json

{
  "name": "Weekly launch digest",
  "trigger": {
    "piece": "schedule",
    "trigger": "every_week",
    "input": {
      "day_of_week": 1,
      "hour_of_the_day": 9
    }
  },
  "steps": [
    {
      "key": "notify",
      "piece": "slack",
      "action": "send_message",
      "input": {
        "channel": "#marketing",
        "text": "Time to plan the posts for this week"
      }
    }
  ]
}

get

Get a workflow. Step by step, with anything still missing.

tracee workflows get <workflow_id>

• <workflow_id>argumentrequired

  From GET /api/v1/workflows or create

  uuid

tracee workflows get $WORKFLOW_ID

update

Change a workflow draft. Replace its name, trigger or steps (steps replace all steps).

tracee workflows update <workflow_id> [--name <name>] [--trigger <trigger>] [--steps <steps>]

• <workflow_id>argumentrequired

  From GET /api/v1/workflows or create

  uuid

• --namestring

  1–80 characters

• --triggerobject

  JSON text or @file.json.

  Show child attributes
• --stepsobject[]

  Run in order JSON text or @file.json.

  up to 25 items

  Show child attributes

--data <json|@file|-> sends the whole body instead of flags.

tracee workflows update $WORKFLOW_ID --name "Monday launch digest"

test

Test-run a workflow. With sample data; steps that write to other apps or publish are simulated.

tracee workflows test <workflow_id>

• <workflow_id>argumentrequired

  From GET /api/v1/workflows or create

  uuid

tracee workflows test $WORKFLOW_ID