Record a commitment
forbiz_commitRecord an action commitment with a stable key and expected signal time, letting agents track outcomes and resume open objectives when a duplicate is refused.
Instructions
Record an action you will take or took, with the signal you expect back (POST /actions). Always send a commitmentKey (a short stable id for the objective, e.g. 'acme/quote-followup') and expectedSignalAt. A second open commitment with the same key is refused 409 COMMITMENT_ALREADY_OPEN and the body returns the open one: that is how you resume. A look-alike is refused 409 POSSIBLE_DUPLICATE: resend with confirm_new true only if it is a different objective.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| roi | No | What it is worth, each dimension 0-5. Optional; never inferred by Forbiz | |
| verb | No | ||
| dueAt | No | When the action itself is due; without it the action never becomes overdue | |
| projectId | No | UUID of an existing project in this workspace | |
| confirm_new | No | Override a POSSIBLE_DUPLICATE refusal | |
| description | Yes | What the action is, in one sentence | |
| whyThisMove | No | ||
| commitmentKey | No | Stable id of the objective this commitment serves (recommended) | |
| expectedSignal | No | What you expect to see if it worked, e.g. 'Dana replies with a date' | |
| expectedSignalAt | No | When the expected signal should have arrived | |
| expectedSignalSource | No | Where the expected signal will appear |