Run Tool
uproc.process
ActionBusiness appsconnection required
Calls the uProc API with the connection's credentials.
Run one uProc tool over a single row and return its result in the same step — the node for cleaning, validating or enriching a value.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- uProc
- Secret shape
- {"email": "…", "api_token": "…"} — the account email and its API key
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
processor Name of the uProc tool to run, in dashed lower case; uproc.list_groups and uproc.get_tool name the ones your plan can reach. | string | Yes | — | — | get-email-lookup |
params The parameters this tool declares, as a JSON object keyed by parameter name; uproc.get_tool lists them for a given tool. | object | Yes | — | ≥ 1 characters | {"email":"ada@example.com"} |
normalized Let uProc clean the parameter values (trim, case, punctuation) before the tool runs; leave off to send them exactly as supplied. | boolean | No | false | — | — |
cache Reuse a previously resolved answer for the same parameters; turn this off to force uProc to resolve the value again. | boolean | No | true | — | — |
limit Maximum number of rows to return when the tool resolves to more than one. | number | No | 50 | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"cache": true,
"limit": 50,
"normalized": false,
"params": {
"email": "ada@example.com"
},
"processor": "get-email-lookup"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
result True when the tool resolved a value; false when it found nothing. | boolean | — |
message The tool's own output, one property per field it returns. | object | — |
params The parameters as uProc used them, normalised when that was asked for. | object | — |
normalized Whether the parameters were normalised. | boolean | — |
price Cost of this query in the account's currency. | number | — |
time Milliseconds uProc took to resolve the query. | number | — |
total_rows How many rows the tool returned. | number | — |
{
"message": {},
"normalized": false,
"params": {},
"price": 0,
"result": false,
"time": 0,
"total_rows": 0
}Notes
- The processor name is a uProc tool such as get-email-lookup or get-mobile-lookup; uproc.get_tool describes one and names its parameters.
- result=false is a miss, not a failure — the step succeeds and the next node can branch on it. Only a uProc error raises.
See Run Tool run in a workflow.
In a technical demo we add the uProc connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.