Observe a workflow run

Read normalized workflow status and result metadata from a route.

Use getWorkflowRun() when a caller has a workflow name and run id.

const run = await getWorkflowRun('welcome', id)

Add a status route

Every status route follows the same shape:

Read the workflow run id from the request path.
Return getWorkflowRun(name, id).
Map missing ids to the framework's normal error response.

src/server.ts

import { createError, H3 } from 'h3'
import { getWorkflowRun } from '@vitehub/workflow'

const app = new H3()

app.get('/api/workflow/:id', async (event) => {
  const id = event.context.params?.id
  if (!id) {
    throw createError({
      statusCode: 400,
      statusMessage: 'Missing workflow run id.',
    })
  }

  return await getWorkflowRun('welcome', id)
})

export default app

Handle status values

Workflow status is normalized across providers:

Status	Meaning
`queued`	The provider accepted the start.
`running`	The provider reports active work.
`completed`	The workflow finished successfully.
`failed`	The workflow failed.
`unknown`	The provider cannot resolve that run id from this runtime.

Persist what the app owns

Provider status is useful for infrastructure state. Application state still belongs in your app data model when users need durable history.

Store the workflow run id with the domain record that started the workflow:

await saveSignup({
  email: payload.email,
  workflowRunId: run.id,
})

Then use the stored id in your status route.