Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/workflows/{workflow}. |
uid | string | wf_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | WorkflowSpec | Desired state. Required. |
status | WorkflowStatus | Observed 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a workflow. |
GET | list | Lists workflows. |
POST | create | Creates a workflow. |
PATCH | update | Updates a workflow. |
DELETE | delete | Deletes 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