Skip to content
Console
On this page

Workflows

A Workflow is durable work a customer declares: the handler each step of a Run invokes, and its retry and timeout policy.

A Workflow is durable work a customer declares: the handler each step of a Run invokes, and its retry and timeout policy. A Workflow write never starts, completes, or cancels a Run; a Run pins the Workflow generation it started from.

Service Sylphx Workflows · Resource type workflows.sylphx.com/Workflow · Name pattern orgs/{org}/projects/{project}/envs/{env}/workflows/{workflow} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/workflows/{workflow}.
uidstringwf_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specWorkflowSpecDesired state. Required.
statusWorkflowStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a workflow.
GETlistLists workflows.
POSTcreateCreates a workflow.
PATCHupdateUpdates a workflow.
DELETEdeleteDeletes a workflow.

get

Gets a workflow.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow · scope workflows:read · effect read · Request, response and examples

list

Lists workflows.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows · scope workflows:read · effect read · paginated · Request, response and examples

create

Creates a workflow.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows · scope workflows:write · effect write · Request, response and examples

update

Updates a workflow.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow · scope workflows:write · effect write · Request, response and examples

delete

Deletes a workflow.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow · scope workflows:write · effect destructive · Request, response and examples