Automation - ClarusWMS

{
  "resource_name": "goods_out",
  "event": "completed",
  "name": "Email on dispatch",
  "enabled": true,
  "conditions_changes": [
    {
      "type": "ADD",
      "attributes": {
        "condition_code": "account_id",
        "source_path": "data.account_id",
        "operator": "eq",
        "value": "42"
      }
    }
  ],
  "actions_changes": [
    {
      "type": "ADD",
      "attributes": {
        "destination_type": "email",
        "destination_code": "default",
        "parameters_changes": [
          {
            "type": "ADD",
            "attributes": {
              "parameter_code": "email_recipient",
              "value": "[email protected]"
            }
          }
        ]
      }
    }
  ]
}

Automation rule attributes. An automation fires for a resource_name/event pair, is gated by conditions, and runs one or more destination actions.

resource_name

enum<string>

required

The warehouse resource whose events trigger this automation.

Available options:

goods_out,

goods_in,

goods_out_pick_list,

invoice,

load_drop,

stock_balance,

stock,

putaway_task,

failure_event_log,

ftp_file,

ftp_import,

daily_schedule,

weekly_schedule,

monthly_schedule,

one_time_schedule

event

string

required

The event on the resource that triggers the automation. Valid events depend on resource_name — e.g. goods_out: created/completed/updated/processed/cancelled; goods_in: completed/created/cancelled/moved_to_part; schedules: triggered.

enabled

boolean

required

Whether the automation is active.

name

string | null

Display name for the automation.

conditions_changes

object[]

Conditions to add (create) or add/update/destroy (update). All conditions must pass for actions to run.

Show child attributes

actions_changes

object[]

Actions to add (create) or add/update/destroy (update), including their parameters.

Show child attributes