Workflow API reference

Detailed documentation on the workflow API

Note

Dapr Workflow is currently in beta. See known limitations for 1.14.1.

Dapr provides users with the ability to interact with workflows and comes with a built-in dapr component.

Start workflow request

Start a workflow instance with the given name and optionally, an instance ID.

POST http://localhost:3500/v1.0-beta1/workflows/<workflowComponentName>/<workflowName>/start[?instanceID=<instanceID>]

Note that workflow instance IDs can only contain alphanumeric characters, underscores, and dashes.

URL parameters

Request content

Any request content will be passed to the workflow as input. The Dapr API passes the content as-is without attempting to interpret it.

HTTP response codes

Response content

The API call will provide a response similar to this:

{
    "instanceID": "12345678"
}

Terminate workflow request

Terminate a running workflow instance with the given name and instance ID.

POST http://localhost:3500/v1.0-beta1/workflows/<workflowComponentName>/<instanceId>/terminate

Note

Terminating a workflow terminates all of the child workflows created by the workflow instance.

Terminating a workflow has no effect on any in-flight activity executions that were started by the terminated instance.

URL parameters

HTTP response codes

Response content

This API does not return any content.

Raise Event request

For workflow components that support subscribing to external events, such as the Dapr Workflow engine, you can use the following “raise event” API to deliver a named event to a specific workflow instance.

POST http://localhost:3500/v1.0-beta1/workflows/<workflowComponentName>/<instanceID>/raiseEvent/<eventName>

Note

The exact mechanism for subscribing to an event depends on the workflow component that you’re using. Dapr Workflow has one way of subscribing to external events but other workflow components might have different ways.

URL parameters

HTTP response codes

Response content

None.

Pause workflow request

Pause a running workflow instance.

POST http://localhost:3500/v1.0-beta1/workflows/<workflowComponentName>/<instanceId>/pause

URL parameters

HTTP response codes

Response content

None.

Resume workflow request

Resume a paused workflow instance.

POST http://localhost:3500/v1.0-beta1/workflows/<workflowComponentName>/<instanceId>/resume

URL parameters

HTTP response codes

Response content

None.

Purge workflow request

Purge the workflow state from your state store with the workflow’s instance ID.

POST http://localhost:3500/v1.0-beta1/workflows/<workflowComponentName>/<instanceId>/purge

Note

Only COMPLETED, FAILED, or TERMINATED workflows can be purged.

URL parameters

HTTP response codes

Response content

None.

Get workflow request

Get information about a given workflow instance.

GET http://localhost:3500/v1.0-beta1/workflows/<workflowComponentName>/<instanceId>

URL parameters

HTTP response codes

Response content

The API call will provide a JSON response similar to this:

{
  "createdAt": "2023-01-12T21:31:13Z",
  "instanceID": "12345678",
  "lastUpdatedAt": "2023-01-12T21:31:13Z",
  "properties": {
    "property1": "value1",
    "property2": "value2",
  },
  "runtimeStatus": "RUNNING",
 }

Component format

A Dapr workflow.yaml component file has the following structure:

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
spec:
  type: workflow.<TYPE>
  version: v1.0-alpha1
  metadata:
  - name: <NAME>
    value: <VALUE>

However, Dapr comes with a built-in dapr workflow component that is built on Dapr Actors. No component file is required to use the built-in Dapr workflow component.

Next Steps

• Workflow API overview
• Route user to workflow patterns

Last modified October 11, 2024: Fixed typo (#4389) (fe17926)