Adding an Entity to your Workflow

How-to Guide

Author:

Fluent Commerce

Changed on:

14 Sept 2025

Key Points

It’s possible to add a new entity to an existing Workflow by modifying the original Workflow. In order to do so, a “CREATED” status and a CREATE Ruleset need to be added for the new entity.
This is not feasible via “ADD RULESET".

Steps

Adding an Entity to your Workflow

To add a Entity to your workflow, at a minimum you will need to:

add a CREATE Ruleset to your Workflow JSON for the new Entity that has the status "CREATED" as a trigger. You will not be able to do this via the 'ADD RULESET'.
add a CREATED status for the new Entity

Note

You can only add new Entities to a Workflow via the JSON document.

Adding an Entity via the Workflow JSON

1{
2    "rulesets": [
3        {
4            "name": "CREATE",
5            "description": "",
6            "type": "{{newEntityType}}",
7            "eventType": "NORMAL",
8            "rules": [],
9            "triggers": [
10                {
11                    "status": "CREATED"
12                }
13            ],
14            "userActions": []
15        }
16    ],
17    "statuses": [
18        {
19            "name": "CREATED",
20            "entityType": "{{newEntityType}}",
21            "category": "{{category}}"
22        }
23    ]
24}

Adding an Entity to your Workflow

To add a Entity to your workflow, at a minimum you will need to:

add a CREATE Ruleset to your Workflow JSON for the new Entity that has the status "CREATED" as a trigger. You will not be able to do this via the 'ADD RULESET'.
add a CREATED status for the new Entity

Note

You can only add new Entities to a Workflow via the JSON document.

Adding an Entity via the Workflow JSON

1{
2    "rulesets": [
3        {
4            "name": "CREATE",
5            "description": "",
6            "type": "{{newEntityType}}",
7            "eventType": "NORMAL",
8            "rules": [],
9            "triggers": [
10                {
11                    "status": "CREATED"
12                }
13            ],
14            "userActions": []
15        }
16    ],
17    "statuses": [
18        {
19            "name": "CREATED",
20            "entityType": "{{newEntityType}}",
21            "category": "{{category}}"
22        }
23    ]
24}

Adding an Entity to your Workflow

Key Points

Steps

Adding an Entity to your Workflow

Adding an Entity to your Workflow

Adding an Entity via the Workflow JSON

Fluent Commerce

Building Blocks

By Type

Helpful Resources

Quick Links

Adding an Entity to your Workflow

Adding an Entity to your Workflow

Adding an Entity via the Workflow JSON