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

Test Support Tool

View as MarkdownAgent setup

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.

POST
/projects/{projectId}/support/tools/test

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

projectIdrequiredstring

ID of the project that owns the tool.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

authHeaderNamestring

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

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

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

Value in: "json" | "form"
contextParametersarray<string>

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

methodstring

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

Value in: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
requestBodystring

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

requestHeadersarray<object>

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

keyrequiredstring
valuerequiredstring
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
sourceobject | object | object | object
endpointstring

https URL on a public host. Omit it for an endpointless catalog or MCP tool.

testValuesrequiredobject

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}

List Support Tools

Lists the support tools authored for this project, including drafts.

Update Support Tool

Replaces one support tool in place. tool.id must equal toolId.