Deploying A Workflow
A workflow turns an input into useful output: a summary, review item, task, note, notification, or other action. Deploy workflows conservatively. Start with read-only behavior, observe it in Activity, then add side effects only when the review path is clear.
Workflow Shape
Section titled “Workflow Shape”| Stage | Question |
|---|---|
| Input | What starts the workflow? |
| Context | What data is needed? |
| Model route | Which model path should handle it? |
| Plugins | Which services may it read or write? |
| Output | What durable result should be produced? |
| Review | What needs human confirmation? |
Safe Deployment Steps
Section titled “Safe Deployment Steps”- Define the workflow goal in one sentence.
- Identify the minimum context needed.
- Start with read-only plugin access.
- Run manually before scheduling.
- Inspect Activity for inputs, tools, provider route, and result.
- Add review gates before external side effects.
- Add scheduling or triggers only after manual runs behave correctly.
Inputs
Section titled “Inputs”Workflows can be manual, scheduled, file-triggered, plugin-triggered, or API-triggered depending on the installed packs and app version.
For public guidance, avoid relying on private folder names or personal vault paths. Use the app’s setup and configuration surfaces to choose the real source.
Outputs
Section titled “Outputs”Common outputs include:
- a generated vault note,
- a digest,
- a review item,
- a task request,
- a notification,
- or an Activity record only.
Prefer Activity-only or review-first output while testing.
Review Gates
Section titled “Review Gates”Use review when a workflow could:
- write to an external service,
- send a message,
- change a calendar,
- make a financial or legal recommendation,
- expose sensitive local context,
- or act on content from an untrusted source.
Review is not a failure. It is the correct surface for human judgement.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Where To Check |
|---|---|
| Workflow does not appear | Pack installation and workflow availability. |
| Workflow cannot start | Status for helper, provider, and plugin readiness. |
| Workflow fails | Activity detail for the recorded run. |
| Output is missing | Review queue, privacy exclusions, and plugin permissions. |
Related concepts
Section titled “Related concepts”- Agency Model — workflows compose typed primitives gated by the tool-surface authoriser
- Packs And Trust — packs are the durable home for shareable workflows and their review policy