Types

WorkflowStep

One step of a transaction workflow, or one branch of a branched step.

idrequired
string (uuid)
The step id.
workflow_idrequired
string (uuid)
The workflow the step belongs to.
namerequired
string
The machine name. The committed and completed steps are required before a deal can use the workflow.
labelrequired
string
The name people see.
typerequired
string
What the step does, as the app names it: default or kyc for a linear step, branch_split for a branched step and branch_parallel for a branch. Defaults to default; kind sets the branch types.
kindrequired
string
linear for a step in the main chain, branched for a step that splits into branches, and branch for one of those branches.One of: linear, branched, branch
descriptionrequired
string | null
What the step asks of the investor.
is_protectedrequired
boolean
A protected step cannot be deleted.
is_floatingrequired
boolean
A floating step can be recorded at any point, outside the main chain.
orderrequired
integer | null
The step's position in the workflow, from 1, as its links give it. Steps on parallel branches share a position. Null for a floating step.
has_custom_formrequired
boolean
Whether the step asks the investor to complete a custom form. Set it to false to remove the form and its form and document-generation triggers.
is_internal_onlyrequired
boolean
Whether only internal users can move investors onto the step.
show_default_internal_messagerequired
boolean
Whether an internal-only step tells investors that their transaction is being processed internally. Defaults to true; set it only on an internal-only step.
document_uploadrequired
object | null
The document an investor uploads to enter the step, or null. Send null to remove it.
minimum_investmentrequired
object | null
Whether the step holds investors to the deal's minimum investment on its committed and confirmed amounts, or null. Send null to remove it.
document_releaserequired
object | null
Whether the step releases the documents in its deal folders to the investor, or null. Setting it creates the folders for deals using the workflow and renames existing ones; null keeps them.
webhookrequired
object | null
The webhook the step sends with the investor, deal and event, or null.
posts_to_portfoliorequired
boolean
Whether the step posts the investment to Portfolio. Each deal names the asset with a step config override.
info_bannerrequired
object | null
The banner shown to investors on the step, or null.
requirementsrequired
object[]
What an investor needs to enter or leave the step.
triggersrequired
object[]
What happens when an investor enters or leaves the step.
created_atrequired
string (date-time)
When the step was created.
updated_atrequired
string | null (date-time)
When the step last changed.

Used by (5)