Skip to main content
POST
Validate a workflow definition

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app whose workflows you want to work with.

Body

application/json
definition
Definition · object
required

The CNCF Serverless Workflow v1.0 document to check.

Example:

Response

The verdict. Check valid, not the status code.

valid
boolean
required

Whether the definition can be saved as-is.

Example:

true

errors
Errors · object[]

What is wrong with the definition, one entry per problem, each with a code, a human-readable message, and a location pointing into the definition. Empty when valid is true.

Example:
supported_task_types
string[]

The fixed set of task types a definition's do steps can use, call, switch, or wait. This doesn't vary by app.

Example:
available_activities
string[]

The activities a call task on this app can invoke. This varies by app.

Example: