Add Task
add_taskAdd a website task or empty task to an existing draft. Omit blockId; the server generates and returns it. Use the returned ID for later edits. Flat fields; no configuration object. Omit wording only for an intentionally incomplete draft. Supply url for a website task; isPrototype defaults to false for a regular website. Set isPrototype=true for a prototype website. stopCondition requires url. Use add_test_block for uploaded prototypes or advanced settings. No launch. The concrete action the tester performs in the product. When drafting or suggesting wording, write one short sentence, usually 10–25 words: [action verb] + [single concrete target] + [essential method or constraint]. Describe one coherent goal; naturally paired actions are fine, but split independent goals into separate tasks. If multiple items could match, identify one by name or position; avoid "any item". Name the in-app mechanism when needed. Keep motivation and backstory in scenario, observable completion criteria in stopCondition, and judgments or research objectives in follow-up survey questions. Omit step-by-step navigation and unnecessary detail. Example: "Book a table for 2 at Bar Mut for tonight at 8:00 PM." Preserve supplied or accepted wording unless the user requests a rewrite or delegates wording choices. When drafting or suggesting scenario wording, write 1–3 short sentences in second person, present tense ("You are…", "You have…"). Describe a believable situation and a concrete triggering moment explaining why the tester needs to act now. Keep the action in the task; do not repeat it here. Example: "It is Friday evening, you are exhausted from work, and you do not want to cook tonight." Preserve supplied or accepted wording unless the user requests a rewrite or delegates wording choices. When drafting or suggesting stopCondition wording, write one short sentence starting with "Stop when". Name one observable on-screen state detectable from a screenshot or DOM that marks the task’s natural completion. Avoid alternative endings, user feelings and off-screen events such as receiving an email; do not stop mid-flow. Example: "Stop when the order confirmation page displays the order number and total amount." Preserve supplied or accepted wording unless the user requests a rewrite or delegates wording choices.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| task | No | Draft one short sentence, usually 10–25 words: action + one target + essential constraints. Preserve accepted wording. | |
| testId | Yes | ||
| blockId | No | Omit when creating a task; the server returns its blockId. Supplied IDs are supported for existing clients. | |
| position | No | ||
| scenario | No | Draft 1–3 short sentences in second person, present tense: situation + reason to act now. Do not repeat the task. | |
| isPrototype | No | Defaults to false for a regular website. Set true for a prototype website. | |
| stopCondition | No | Draft one short "Stop when" sentence naming an observable on-screen state at task completion. No alternatives or off-screen events. | |
| expectedRevision | No | Legacy compatibility only; ignored. Draft revisions are resolved automatically. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Open the draft in Uxia. | |
| testId | No | ||
| blockId | No | Server-assigned ID of the added block. Use it for subsequent edits and references. | |
| editable | No | ||
| definition | Yes |