Skip to main content
Version: 5.1

Create a Workflow

A durable workflow is an artifact in your integration, the same as a service or an automation. You create it once, give it the shape of the data it starts with, and then design its steps on a diagram.

Launch the wizard​

  1. In the design view, click + Add Artifact.

  2. On the Artifacts page, under Durable Workflow, click Durable Workflow.

    The Artifacts page with the Durable Workflow card under the Durable Workflow sectionThe Artifacts page with the Durable Workflow card under the Durable Workflow section

    Durable Agentic Workflow, under AI Integration on the same page, produces the same kind of artifact, but you describe the goal and let a model choose the steps instead of wiring them yourself. See Create a Durable Agent.

  3. Fill in the Create New Durable Workflow form:

    FieldRequiredDescription
    NameYesThe workflow's identifier. It is how the workflow is referenced when it is started, and the name it appears under in workflow management.
    Workflow Input Data TypeNoThe type of the data the workflow starts with, usually a record. See Types.
    Design it for the launcher

    Whatever you put in this type is what every caller has to supply, including the form the Integration Control Plane generates for starting a run by hand. Keep it to the data the process actually needs.

    The Create New Durable Workflow form with Name set to orderWorkflow and Workflow Input Data Type set to OrderInfoThe Create New Durable Workflow form with Name set to orderWorkflow and Workflow Input Data Type set to OrderInfo
  4. Click Create.

The workflow opens on its own diagram with a single Start node and appears under Workflows in the sidebar.

For a worked example that fills this in end to end, see Build an order processing workflow.

Design the steps​

The workflow diagram is the same flow diagram used everywhere else in WSO2 Integrator, with a group of durable steps added to the node panel:

GroupWhat it holds
Workflow > StepsCall Activity, Human Task, Await Data, and Sleep.
Workflow > Workflow FunctionsReplay-safe helpers: current time, whether the run is replaying, the run's own ID and type, and who completed the last human task or decided the last review.
Workflow > Child WorkflowsStart another workflow as a child of this one, wait for it, or send it data.
Statement, Control, Error HandlingThe ordinary building blocks: variables, function calls, if, while, foreach, and error handling.

Next steps​

On this page
Was this page helpful?
Report an issue