skills/hubspot__agent-cli-skills
1
0
Fork 0
mirror of https://github.com/HubSpot/agent-cli-skills.git synced 2026-09-19 07:39:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Warn that workflows create --dry-run does not validate the body

Browse Source 
`create --dry-run` is a no-op echo: it makes no API call and returns
ok:true even for a body that is not a valid create (e.g. {"nope":true},
or one missing type/flowType/objectTypeId/actions). A green dry-run
therefore only proves the input is well-formed JSON, not that the create
would succeed. Without this note an agent would trust the dry-run as
validation and ship an invalid body — and the trap is easy to miss
because `update --dry-run` does reject bodies missing required fields.
This commit is contained in:
Brigitte Kawaguchi
2026-06-24 11:03:28 -07:00
parent 62ddd52861
commit 6c99686c3f
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
workflow-automation/SKILL.md
+2
View File
@@ -75,6 +75,8 @@ cat workflow.json | hubspot workflows create # stdin also works
Set `type` (`CONTACT_FLOW` or `PLATFORM_FLOW`), `flowType` (`WORKFLOW`), and `objectTypeId` (e.g. `0-1` for contacts) — all required on create. See `resources/workflow-json-reference.md` for the body shape and `resources/example-contact-flow.json` for the minimal template. **Easiest path: `get` an existing similar workflow as a starting template** rather than hand-writing the JSON.
**Pitfall: `create --dry-run` does not validate the body.** It echoes the JSON back with `ok:true` and makes no API call — a green dry-run proves only that the input is well-formed JSON, not that it's a valid create (a body missing `type`/`flowType`/`objectTypeId`/`actions` still returns `ok:true`). The only real validation is the live `create`. By contrast, `update --dry-run` does reject a body missing required fields like `revisionId`.
**Branching and convergence.** A `LIST_BRANCH` action forks the path on filter criteria; each branch — and the `defaultBranch` — carries a `connection` to the action it continues to. Because connections target actions by `nextActionId`, **branches can converge**: point two branches at the same `actionId` and both paths continue to one shared action, no duplication. See the branching section of `resources/workflow-json-reference.md` and `resources/example-branching-flow.json`.
## 4. Update — full PUT, get-modify-put round-trip