Desktop: heartbeat creation has an undocumented destination/targetThreadId requirement
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 125k
- Forks
- 19.4k
- PR merge metrics
- PR metrics pending
Description
Summary
The model-facing codex_app.automation_update contract leaves a conditional requirement unstated: heartbeat creation needs an explicit targetThreadId or destination: "thread", although both fields are advertised as optional and the description presents heartbeats as attached to the current task.
This is a small schema/documentation mismatch, not a claim that heartbeat creation is generally broken.
Environment
- Windows, Codex Desktop; observed September 11, 2026.
- Source session metadata records CLI version
0.153.4. - The exact Desktop package build was not captured in this occurrence's evidence.
Observed sequence
- In an existing local task, the agent invoked
automation_updatewithmode: "create"andkind: "heartbeat", omitting both destination and targetThreadId. - The tool rejected creation with:
Missing targetThreadId or destination=thread - The first call was an explicit validation failure; no automation was created.
- Creation succeeded after explicitly supplying
destination: "thread". No duplicate automation was created.
The heartbeat branch exposed to the agent marks destination? and targetThreadId? optional without stating that one is required for create. The same omission remains in the tool description available to this reporting task; no new automation was created merely to reproduce the error.
Expected
Either default an omitted target to the calling local task, or explicitly document and encode the conditional requirement in the model-facing create schema: supply a targetThreadId OR destination="thread".
Impact and workaround
One avoidable failed tool call and a corrective creation call. Use destination: "thread" for a heartbeat attached to the current task. No data loss or scheduler failure was observed.
Related: #35601 concerns a different schema problem in which the heartbeat branch is absent entirely; here heartbeat is exposed and works once the unstated target requirement is satisfied.
No automation prompt, task IDs, account data, credentials, or raw logs are included.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the model-facing codex_app.automation_update contract and its heartbeat create schema or tool description. Check how destination and targetThreadId are described and validated; done means the conditional requirement is explicit and consistent, with the existing destination="thread" workaround covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100