Automation > Workflows
Search docs
Sign InWorkflows
Workflows let you define automated multi-step processes triggered by shop events. Use the Workflows API to create and manage automation rules that respond to events such as order placement or inventory changes.
Endpoints
| Endpoint | Description | JSON API |
|---|---|---|
| workflows | Get workflow endpoints | GET:workflows.json |
| workflowsCreate | Create workflow endpoints | POST:workflows.json |
| workflowsDelete | Delete workflow endpoints | DELETE:workflows.json |
| workflowsExecsPage | Get workflows executions page | GET:workflows/execs/page.json |
| workflowsExecsResume | Resume suspended workflow execution | POST:workflows/execs/resume.json |
| workflowsExecute | Manually execute a workflow | POST:workflows/execute.json |
| workflowsModify | Modify workflow endpoints | POST:workflows.json |
Types
| Types |
|---|
| Workflow |
| WorkflowCreate |
| WorkflowExecPage |
| WorkflowExecute |
| WorkflowExecuteResult |
| WorkflowModify |