trigger_flow
Trigger a published Flow Designer flow or subflow with optional inputs through ServiceNow's server-side FlowAPI, running it in the background. Use it when no REST endpoint exists.
Instructions
Trigger a published Flow Designer flow or subflow in the background with optional inputs, via the server-side sn_fd.FlowAPI runner (requires WRITE_ENABLED=true and SCRIPTING_ENABLED=true; ServiceNow has no REST endpoint for this)
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": {
"flow_sys_id": "<flow_sys_id>"
},
"name": "trigger_flow"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| async | No | Run as a background job and return a job_id at once. Poll it with get_job. Calls that take longer than about 20 seconds switch to a job on their own. | |
| inputs | No | Key-value pairs for flow input variables | |
| flow_sys_id | Yes | sys_id of the flow to trigger |