Saasco logoSaasco logo
Saasco logoSaasco logo

Introduction

OverviewGetting startedAgent setupWhat is Saasco?

SDK

Quick startTrackingIdentifyConfigurationWidgetsProperties

MCP

Quick startHow it worksAuthorizationTool reference
Skills for agents

REST API

Quick start
Support tools

Create Support Tool

View as MarkdownAgent setup

Creates one support tool the support agent can call.

POST
/projects/{projectId}/support/tools

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

projectIdrequiredstring

ID of the project that will own the tool.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

toolrequiredobject

Tool to create. Field descriptions on this object are the authoring contract.

descriptionrequiredstring
inputSchemarequiredobject

JSON Schema object (type "object") of arguments the model fills. Names listed in contextParameters or serverParameters are not left for the model.

typerequiredstring
propertiesobject
requiredarray<string>
additionalPropertiesunknown
methodstring

HTTP method the tool calls. Omit it for an MCP tool, which has no URL.

Value in: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
contextParametersarray<string>

Parameter names filled from the live visitor, not by the model. Use {name} in the endpoint, body, or a header.

requestBodystring

JSON or form template. A parameter is sent in the body when its {name} placeholder appears here.

endpointstring

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.

serverParametersarray<object>

How each server-filled parameter is resolved: context, attribute, custom, or model.

namerequiredstring
sourcerequiredstring

"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.

Value in: "context" | "attribute" | "custom" | "model"
attributeKeystring
valuestring
fallbackstring
authTypestring

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.

Value in: "none" | "bearer" | "apiKey"
authHeaderNamestring

Header name for authType "apiKey", such as X-API-Key. The token is read from the integration, not from this field.

approvalstring

"user" asks the visitor to confirm before the call. "none" runs immediately. Omitted means none.

Value in: "none" | "user"
contentTypestring

Body encoding for a server tool. "json" is the default. "form" sends application/x-www-form-urlencoded.

Value in: "json" | "form"
responseFieldsarray<object>
pathrequiredstring
includedrequiredboolean
displayNamestring
transformationsarray<object>
fromrequiredstring
torequiredstring
descriptionPartsobject
whatItDoesstring
whenToUsestring
whenNotToUsestring
namerequiredstring

Display name. It is normalized into the identifier the agent calls.

activationConditionsarray<object>
fieldrequiredstring
operatorrequiredstring
Value in: "IS_SET" | "IS_NOT_SET" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "GREATER_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN" | "LESS_THAN_OR_EQUAL"
valuestring | null
requestHeadersarray<object>

Extra headers. value may be a literal or a {param} template.

keyrequiredstring
valuerequiredstring
sourceobject | object | object | object
responseExampleobject
jsonrequiredstring
moderequiredstring
Value in: "live" | "mock"
authSourceobject

Where the auth token is stored. { kind: "integration", integrationId } or { kind: "integration", serviceName }. Never send the token or the integration key.

kindrequiredstring
integrationIdstring
serviceNamestring
enabledrequiredboolean

When false, an active tool is paused and is not offered to the visitor.

executionstring

host runs in the visitor's browser. server is proxied by Saasco. An MCP tool is server with source.kind "mcp".

Default: "host"Value in: "host" | "server"
statusrequiredstring

draft is saved but not offered to the agent. active is offered when enabled is true.

Value in: "draft" | "active"

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    }  ]}

Delete Support Tool

Permanently deletes one support tool. This cannot be undone. To pause a tool instead, update it with enabled false.