Test Support Tool
Runs one server or MCP support tool with the supplied testValues and returns { ok, status, body }. Does not save the tool. endpoint, when present, must be an https URL on a public host. Auth is resolved from authSource and is not included in the result. testValues supplies model and context parameter values in place of a live visitor.
Authorization
Authorization In: header
Path Parameters
ID of the project that owns the tool.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Header name for authType "apiKey", such as X-API-Key. The token is read from the integration, not from this field.
Where the auth token is stored. { kind: "integration", integrationId } or { kind: "integration", serviceName }. Never send the token or the integration key.
How the proxied request authenticates. "none" sends no credential. "bearer" sends Authorization: Bearer from the integration. "apiKey" sends authHeaderName from the integration. The token is not stored on the tool.
Body encoding for a server tool. "json" is the default. "form" sends application/x-www-form-urlencoded.
Parameter names filled from the live visitor, not by the model. Use {name} in the endpoint, body, or a header.
HTTP method the tool calls. Omit it for an MCP tool, which has no URL.
JSON or form template. A parameter is sent in the body when its {name} placeholder appears here.
Extra headers. value may be a literal or a {param} template.
How each server-filled parameter is resolved: context, attribute, custom, or model.
"context" reads live visitor state. "attribute" reads a CRM attribute (attributeKey). "custom" sends the static value. "model" is filled by the agent, with optional fallback.
https URL on a public host. Omit it for an endpointless catalog or MCP tool.
Values for the model and context parameters, keyed by name, in place of a live visitor.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/projects/string/support/tools/test" \ -H "Content-Type: application/json" \ -d '{ "testValues": { "property1": "string", "property2": "string" } }'{ "ok": true, "status": 0, "body": null}