Flow Framework

⚡ Built-in — Platform Built-in

Status-driven workflow engine. Define multi-actor workflows with states, transitions and guards. Internal and external actors collaborate via a tamper-proof state machine.

⚡ Built-in — No Setup Required This integration is built into the WebsitePublisher platform. All endpoints are available immediately — no API key needed.

Endpoints (14)

POST create_definition

Create a flow definition with states, transitions and optional steps.

Field	Type	Required
`name`	string	✓ Yes
`slug`	string	✓ Yes
`initial_state`	string	✓ Yes
`states`	array	✓ Yes
`transitions`	array	✓ Yes
`steps`	array	No

POST get_definition

Get a flow definition by slug. Returns the active version unless a specific version is requested.

Field	Type	Required	Description
`slug`	string	✓ Yes
`version`	integer	No

POST list_definitions

List all flow definitions for this project. Shows the active version of each flow plus whether a draft is waiting.

Field	Type	Required	Description
`include_versions`	boolean	No

POST delete_definition

Delete one version of a flow definition. Without version the active one is deleted. Only allowed if no active instances exist on that version.

Field	Type	Required	Description
`slug`	string	✓ Yes
`version`	integer	No

POST create_version

Create a new draft version of a flow definition, copied from the active version. The draft always starts unapproved: actions on it do not run until reviewed.

Field	Type	Required	Description
`slug`	string	✓ Yes
`from_version`	integer	No

POST update_version

Update the draft version of a flow definition. Only drafts can be edited; active and retired versions are immutable because instances may be running on them.

Field	Type	Required
`slug`	string	✓ Yes
`name`	string	No
`initial_state`	string	No
`states`	array	No
`transitions`	array	No
`steps`	array	No

POST publish_version

Publish a version: it becomes active and the previous active version is retired. Without version the draft is published; with version you can roll back to an earlier one. Running instances stay on the version they started on.

Field	Type	Required	Description
`slug`	string	✓ Yes
`version`	integer	No

POST create_instance

Start a new flow instance from a definition.

Field	Type	Required
`definition_slug`	string	✓ Yes
`external_actor_email`	string	No
`internal_actor_id`	integer	No
`meta`	object	No

POST list_instances

List flow instances, optionally filtered by state or definition.

Field	Type	Required
`state`	string	No
`definition_slug`	string	No
`limit`	integer	No

POST get_instance

Get a flow instance with current state and available transitions.

Field	Type	Required	Description
`instance_id`	integer	✓ Yes

POST advance

Trigger a state transition on a flow instance. Guards are evaluated server-side before applying.

Field	Type	Required
`instance_id`	integer	✓ Yes
`trigger`	string	✓ Yes
`data`	object	No

POST submit_step

Save step data without triggering a transition.

Field	Type	Required
`instance_id`	integer	✓ Yes
`step_id`	string	✓ Yes
`data`	object	✓ Yes

POST get_history

Get the full audit trail for a flow instance.

Field	Type	Required	Description
`instance_id`	integer	✓ Yes

POST get_available_transitions

Get all transitions the current actor can trigger from the current state.

Field	Type	Required	Description
`instance_id`	integer	✓ Yes
`actor_type`	string	No

MCP Tool Names

When using this integration through an AI assistant (Claude, ChatGPT, Cursor, etc.), the endpoints are available as MCP tools:

Endpoint	MCP Tool Name
create_definition	`flow_framework_create_definition`
get_definition	`flow_framework_get_definition`
list_definitions	`flow_framework_list_definitions`
delete_definition	`flow_framework_delete_definition`
create_version	`flow_framework_create_version`
update_version	`flow_framework_update_version`
publish_version	`flow_framework_publish_version`
create_instance	`flow_framework_create_instance`
list_instances	`flow_framework_list_instances`
get_instance	`flow_framework_get_instance`
advance	`flow_framework_advance`
submit_step	`flow_framework_submit_step`
get_history	`flow_framework_get_history`
get_available_transitions	`flow_framework_get_available_transitions`

← Back to all integrations