Add Task To Runbook
add_task_to_runbookAdd a new task to an existing runbook, specifying its name, level, duration, assignees, predecessors, and task type so it slots into the runbook sequence correctly.
Instructions
Add a new task to an existing runbook.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"runbook_id": "<runbook_id>",
"name": "<name>"
},
"name": "add_task_to_runbook"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the new task. | |
| level | No | The task's level (default level_3). | |
| message | No | For an Email/SMS/Call comms task type, the message body. For an agentic task type, the initial prompt: the instructions the AI agent receives when the task starts. Always set it for comms and agentic tasks; if the user did not supply one, draft it from the task name, description and the runbook context. | |
| duration | No | Planned duration in seconds. | |
| assignees | No | List of assignees to add to the task. Only users and teams that are already participants on the runbook can be assigned; non-participants are silently ignored by the API. | |
| end_fixed | No | ISO 8601 timestamp fixing the task's end time. | |
| stream_id | No | The ID of the stream to assign the task to (can be a substream). | |
| auto_start | No | Whether the task should start automatically once its predecessors complete. | |
| recipients | No | List of recipients for a comms task (Email/SMS/Call). | |
| runbook_id | Yes | The ID of the runbook to add the task to. | |
| task_links | No | Links from this task to other resources. Use ``link_type="runbook"`` to link a task to a template runbook — the target must be a template and must have ≥1 task, and the task's ``task_type_id`` must be the tenant's ``linked`` task type (from ``list_task_types``, the entry with ``key == "linked"``) or the link is silently dropped. If the parent runbook isn't a template, the response's ``task_links[].id`` references a freshly-spawned copy of the template, not the template itself, and the task's name is overwritten with the target's name. Use ``link_type="snippet"`` to attach one or more snippets. | |
| auto_finish | No | Whether the task should complete automatically once started. | |
| description | No | An optional description for the task. | |
| start_fixed | No | ISO 8601 timestamp fixing the task's start time. | |
| predecessors | No | A list of task IDs that are predecessors to this task. | |
| task_type_id | No | Task type ID from ``list_task_types``, which also lists integration-backed types (Jenkins, ServiceNow, custom integrations, AI agent tasks, ...); never ask the user for the id. | |
| custom_field_values | No | Custom field values to set. Identify each field by custom_field_id, using the id returned by list_custom_fields with scope="task": {"custom_field_id": "123", "value": ...}. A field's internal ``name`` can be used instead of the id, but its ``display_name`` cannot. For select_menu and radiobox fields, pass the option name; for checkboxes, pass a list of option names. Pass "" to clear a field. If the API reports 'Custom field "" was not found' for a valid id, the field is most likely not available for the task's type. Values in the response are listed by ``name``, with custom_field_id set to null. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| included | No |