Create Custom Field
create_custom_fieldDefines a new custom field for Cutover runbooks or tasks, choosing its type, placement and options so teams can capture required data. Check existing fields first to avoid duplicates.
Instructions
Create a custom field definition (the Custom Fields admin page). This defines a new field; to set a value on a runbook or task, use custom_field_values on the runbook and task tools.
Requires the Custom Fields Admin role (or Global Admin). Check list_custom_fields first so an existing field is reused rather than duplicated.
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": {
"name": "<name>",
"field_type": "<field_type>",
"apply_to": "<apply_to>"
},
"name": "create_custom_field"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The field's name. | |
| apply_to | Yes | Where the field appears: runbook_add_edit / runbook_edit (runbook details), runbook_page (runbook homepage), task_add_edit / task_edit (task details), task_start or task_end (asked when a task starts or finishes). | |
| required | No | Whether a value must be given. | |
| field_type | Yes | text, textarea, select_menu, radiobox, checkboxes, datetime or user_select. | |
| display_list | No | Show the value as a pill in runbook and task lists. | |
| global_field | No | Create the field for every workspace on the instance. Must be set explicitly, and only when the user asks for a global field, since every workspace sees it. | |
| workspace_id | No | The workspace that owns the field. Required unless global_field is True. | |
| default_value | No | The value a new runbook or task starts with. | |
| display_table | No | Include the field in table views. | |
| field_options | No | Option names. Required for select_menu, radiobox and checkboxes, and not allowed for other field types. | |
| task_type_ids | No | Limit a task field to these task types (see list_task_types). | |
| display_search | No | Allow filtering by this field. | |
| runbook_type_ids | No | Limit the field to these runbook types (see list_runbook_types). | |
| allow_field_creation | No | Let users add options from within a runbook. | |
| custom_field_group_id | No | The group to show the field in (see list_custom_field_groups). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||