Create Support Tool
Creates one support tool the support agent can call.
Authorization
Authorization In: header
Path Parameters
ID of the project that will own the tool.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Tool to create. Field descriptions on this object are the authoring contract.
JSON Schema object (type "object") of arguments the model fills. Names listed in contextParameters or serverParameters are not left for the model.
HTTP method the tool calls. Omit it for an MCP tool, which has no URL.
Parameter names filled from the live visitor, not by the model. Use {name} in the endpoint, body, or a header.
JSON or form template. A parameter is sent in the body when its {name} placeholder appears here.
Server tools: https URL on a public host. Host tools: a relative path such as /api/orders/{id}, or omit it. MCP tools omit it.
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.
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.
Header name for authType "apiKey", such as X-API-Key. The token is read from the integration, not from this field.
"user" asks the visitor to confirm before the call. "none" runs immediately. Omitted means none.
Body encoding for a server tool. "json" is the default. "form" sends application/x-www-form-urlencoded.
Display name. It is normalized into the identifier the agent calls.
Extra headers. value may be a literal or a {param} template.
Where the auth token is stored. { kind: "integration", integrationId } or { kind: "integration", serviceName }. Never send the token or the integration key.
When false, an active tool is paused and is not offered to the visitor.
host runs in the visitor's browser. server is proxied by Saasco. An MCP tool is server with source.kind "mcp".
draft is saved but not offered to the agent. active is offered when enabled is true.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/projects/string/support/tools" \ -H "Content-Type: application/json" \ -d '{ "tool": { "description": "string", "inputSchema": { "type": "object", "property1": null, "property2": null }, "name": "string", "enabled": true, "status": "draft" } }'{ "description": "string", "inputSchema": { "type": "object", "properties": { "property1": null, "property2": null }, "required": [ "string" ], "additionalProperties": null, "property1": null, "property2": null }, "method": "GET", "contextParameters": [ "string" ], "requestBody": "string", "endpoint": "string", "serverParameters": [ { "name": "string", "source": "context", "attributeKey": "string", "value": "string", "fallback": "string" } ], "authType": "none", "authHeaderName": "string", "approval": "none", "contentType": "json", "responseFields": [ { "path": "string", "included": true, "displayName": "string", "transformations": [ { "from": "string", "to": "string" } ] } ], "descriptionParts": { "whatItDoes": "string", "whenToUse": "string", "whenNotToUse": "string" }, "name": "string", "activationConditions": [ { "field": "string", "operator": "IS_SET", "value": "string" } ], "source": { "kind": "integration", "serviceName": "string", "catalogToolId": "string" }, "responseExample": { "json": "string", "mode": "live" }, "authSource": { "kind": "integration", "integrationId": "string", "serviceName": "string" }, "enabled": true, "execution": "host", "status": "draft", "id": "string", "authConfigured": true, "requestHeaders": [ { "key": "string", "valueSet": true } ]}