Observability

Overview

Workflow Studio gives operators a small set of read APIs for inspecting workflow activity.

Use them to answer questions like:

• What happened in this run?
• Which step failed?
• Which webhook resumed the run?
• Which events share the same correlation ID?

Main endpoints

Run details

• GET /v1/runs/:id
• GET /v1/runs/:id/steps
• GET /v1/runs/:id/hooks

Use these when you already know the run ID and want the current state plus related records.

Step and hook details

• GET /v1/steps/:id
• GET /v1/hooks/:id

Use these for a single step or hook detail view.

Event timelines

• GET /v1/events?runId=<runId>
• GET /v1/events/correlation/<correlationId>

Use the run timeline when you want the full event history for one run.

Use the correlation endpoint when you want to follow one request, callback, or resume path across related events.

resolveData

The observability routes support resolveData.

Use resolveData=none for list and timeline views where you want lighter responses.

Use resolveData=all for detail views where you need fully hydrated payload data.

Default behavior:

Operator actions that change state

Operators can also act on runs:

• POST /v1/runs/:id/cancel
• POST /v1/runs/resume
• POST /v1/runs/:id/rerun
• POST /v1/runs/:id/wake

Use the observability endpoints before and after these actions to confirm what changed.