OpenWorkflow Workflow
Connect OpenWorkflow and reattach to workflow runs when lookup is available.
OpenWorkflow fits apps that want to bring their own workflow backend. ViteHub keeps the same workflow discovery and start API, while you provide the backend client and optional run lookup integration.
Install the SDK
Terminal
pnpm add https://pkg.pr.new/nuxt-hub/agent/@vitehub/workflow@main openworkflow
Configure OpenWorkflow
nuxt.config.ts
export default defineNuxtConfig({
modules: ['@vitehub/workflow/nuxt'],
workflow: {
provider: 'openworkflow',
},
})
Add workflow.ow when you want ViteHub to use the OpenWorkflow backend client for richer run lookups.
Add run lookup
getWorkflowRun(id) returns null unless you configure a lookup function.
nitro.config.ts
export default defineNitroConfig({
workflow: {
provider: 'openworkflow',
ow,
getRun: async (id) => {
return await ow.backend.getWorkflowRun({ workflowRunId: id })
},
},
})
What changes on OpenWorkflow
| Concern | Behavior |
|---|---|
| Backend client | Use workflow.ow to expose the OpenWorkflow backend client to ViteHub. |
| Run lookup | Use workflow.getRun(id) to make getWorkflowRun(id) work for this provider. |
| OpenWorkflow-only methods | OpenWorkflow runs expose result() under run.openworkflow, including an optional timeout. |
Choose OpenWorkflow when you need ViteHub's workflow file structure but want to supply the execution backend yourself.