---
title: "Test custom tool"
method: POST
path: "/api/custom-tools/{sid}/test"
tags: ["custom_tools"]
---

# Test custom tool

`POST /api/custom-tools/{sid}/test`

## Request

- Base URL: `https://beta.getsales.io/integrations/v1`
- URL: `https://beta.getsales.io/integrations/v1/api/custom-tools/{sid}/test`
- Auth: HTTP bearer and API key in header `Team-SID`

Execute the tool FOR REAL with the given params, through the same executor a production call takes: one HTTP call to the target, logged as a provider_calls row (source_service api, tool_type custom_tool), 0 credits, a fresh idempotency key per press. result carries the outcome verbatim: status, output {status, body, extracted}, the classified error_code and a message that opens with the token of a tool-level failure (custom_tool_disabled, input_binding...), and provider_call_sid for the snapshots. Use it to see what a column would get, or why a tool returns nothing (compare output.body with output_mapping). A dry-run that does not hit the target would validate nothing. Throttled 10 a minute.

Contract:
- MCP tool `test_custom_tool`, registry package `mcp.integrations/custom_tools`, mount `integrations.providers`.
- Operation `action`, response envelope `action`.
- Flags: none.

## Path parameters

- `sid` string, required: Custom tool sid (in_tl_...).

## Request body

- TestCustomToolRequest: Request body of `test_custom_tool`.
  - `params` object: The inputs by key, bound against input_schema (a missing required one fails the row).

## Response `200`

`action` success envelope.

- TestCustomToolResponse
  - `success` true, required
  - `operation` 'action', required
  - `action` string, required: kebab-case verb; matches the route segment.
  - `item` object, nullable, required
    - `sid` string, required: Custom tool sid (in_tl_...).
    - `team_sid` string, required: The owning workspace (ts_tm_...).
    - `name` string, required: Unique within the team among live rows; what the tool pickers show.
    - `description` string, nullable, required: Free text, up to 2000 chars.
    - `provider_connection_sid` string, nullable, required: The connection the tool authenticates with (in_cn_...); null = no auth.
    - `request` object, required: The request template.
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', required: The HTTP method.
      - `url` string, required: https URL; scheme and host literal (no placeholders, default port, public DNS), placeholders in the path and query only.
      - `headers` object: Up to 20 headers; values may hold placeholders. Auth-shaped names (authorization, cookie, token, key...) and Content-Type are refused: auth comes from the connection.
      - `body` object, nullable: A JSON template; null on GET and DELETE. String leaves may hold placeholders; a leaf that IS {{key}} renders with the input's native type.
    - `input_schema` object[], required: The declared inputs (up to 30).
      - `key` string, required: The placeholder name.
      - `type` string, required: string | number | boolean.
      - `required` boolean, required: Whether a call must bind it.
    - `output_mapping` object, required: name to dot-path into the response body (up to 20); {} = the raw body only.
    - `status` 'on' | 'off', required: off = the executor refuses it with a failed row (custom_tool_disabled).
    - `created_by` object, required: Who defined the tool.
      - `actor_type` 'user' | 'support' | 'api_key' | 'system' | 'agent', required
      - `actor_sid` string, nullable, required
      - `team_sid` string, required
      - `actor_name` string, nullable: The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job.
      - `oauth_client_sid` string, nullable: The acting OAuth client (id_oc_*); null off the OAuth path.
      - `reason` string, nullable: Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise.
      - `permissions` object, required: Internal audit context: the grant set the actor held at write time. Not a contract.
      - `cluster_id` integer, nullable: Internal audit context: the cluster that served the write.
      - `trace_id` string, nullable: Internal audit context: the trace id of the request that wrote the row.
    - `deleted_by` object, nullable, required: Who deleted it; null while live.
      - `actor_type` 'user' | 'support' | 'api_key' | 'system' | 'agent', required
      - `actor_sid` string, nullable, required
      - `team_sid` string, required
      - `actor_name` string, nullable: The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job.
      - `oauth_client_sid` string, nullable: The acting OAuth client (id_oc_*); null off the OAuth path.
      - `reason` string, nullable: Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise.
      - `permissions` object, required: Internal audit context: the grant set the actor held at write time. Not a contract.
      - `cluster_id` integer, nullable: Internal audit context: the cluster that served the write.
      - `trace_id` string, nullable: Internal audit context: the trace id of the request that wrote the row.
    - `created_at` string, required: ISO 8601 UTC.
    - `updated_at` string, required: ISO 8601 UTC.
    - `deleted_at` string, nullable, required: ISO 8601 UTC; null = live.
  - `result` object, required
    - `status` string, required: success | failed: the execute outcome.
    - `output` object, nullable, required: {status, body (capped), extracted} of the real call; null on a failure before the call.
    - `error_code` 'auth_error' | 'rate_limited' | 'timeout' | 'network_error' | 'invalid_input' | 'provider_error' | 'not_found', nullable, required: The executor's classified code; null on success.
    - `error_message` string, nullable, required: Opens with the branchable token on a tool-level failure (custom_tool_disabled, input_binding...).
    - `credits_charged` number, required: Always 0 for http.request.
    - `cache_hit` boolean, required: Always false: http.request is never cached.
    - `provider_call_sid` string, required: The logged row (in_pc_...): get_provider_call reads the snapshots.
  - `meta` object, required
    - `trace_id` string, required: UUID v7; same 128-bit value as the X-Trace-Id header.
    - `span_id` string, required: 16 hex chars, root span of this request.
    - `timestamp` string, required: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
    - `duration_ms` integer, required: Server-side wall clock.
    - `team_sid` string, nullable: The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends.
    - `actor_type` string, nullable: user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends.

## Other responses

- `4XX`: MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
- `5XX`: MCP error envelope with `error.code` internal_error or service_unavailable.

---

[API](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-integrations.md) - [All operations](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-integrations/llms.txt) - [OpenAPI document](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-integrations/revisions/2e7105d58335?raw)