Deploying a Tool

Deploying a tool means choosing how its runs start. The tool itself stays in superglue, where the runtime resolves credentials, executes each step, records the result, and makes failures available for investigation. You do not need to ship a separate worker, queue, or cron service.

Open a saved tool and select Deploy to configure the same four deployment paths available throughout superglue:

ScheduleRun recurring work with a cron expression, timezone, and saved input.

SDK or REST APIStart synchronous or asynchronous runs from an application, script, or agent.

WebhooksReact to external events or send a completion callback when a run succeeds.

MCPExpose saved tools to AI clients through the default or a scoped MCP server.

Before you deploy

1. Save the tool: Deployment paths execute the saved tool, not an unsaved playground draft.
2. Test representative input: Run the tool from the playground and verify its final result and any external writes.
3. Check access and credentials: The executing identity needs access to the tool, every referenced system, and the credential selected for each system.

!

Run All Steps is for testing the current playground draft. Use Deploy after saving when the tool should run outside the playground.

Schedule

Use a schedule for recurring syncs, reports, migrations, and maintenance work.

1. Open Deploy, choose Schedule, and select Add Schedule.
2. Choose a preset or enter a five-field cron expression, then select an IANA timezone.
3. Add the JSON input passed to every run.
4. Under Advanced options, optionally select credentials per system, set a run timeout, call a completion webhook, or start another tool when the run finishes.
5. Save the schedule, test it with the configured input, and enable it when ready.

Scheduled runs act as the schedule creator. A credential selected in the schedule is used for that system; systems left unpinned use the creator’s default accessible credential.

The CLI can create the same schedule:

sg schedule create \
  --tool customer-sync \
  --cron "0 9 * * 1-5" \
  --timezone Europe/Berlin \
  --payload '{"status":"active"}'

See Scheduled Execution for schedule management and advanced behavior.

SDK or REST API

Use the SDK or REST API when your application controls when a run starts. Create an API key from API Keys in the organization menu and store it in your application’s secret manager.

The cloud API base URL is https://api.superglue.cloud/v1. Enterprise and self-hosted URLs can vary; use the endpoint shown by your deployment or verify it with the superglue agent.

TypeScript

npm install @superglue/client@latest

import { configure, runTool } from "@superglue/client";

configure({
  apiKey: "YOUR_SUPERGLUE_API_KEY",
  baseUrl: "https://api.superglue.cloud/v1",
});

await runTool("customer-sync", {
  inputs: { status: "active" },
});

REST API

curl -X POST "https://api.superglue.cloud/v1/tools/customer-sync/run" \
  -H "Authorization: Bearer $SUPERGLUE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"inputs":{"status":"active"}}'

CLI

sg tool run --tool customer-sync --payload '{"status":"active"}'

Runs are synchronous by default. Set options.async to true for long-running work, then use the returned run ID to monitor completion. The SDK/API tab in the Deploy dialog generates TypeScript, Python, and cURL examples for the current tool and input.

See the API overview for authentication and the endpoint reference for the complete request and response contract.

Webhooks

Incoming webhooks start a saved tool asynchronously. The POST body becomes the tool input:

POST https://api.superglue.cloud/v1/hooks/{toolId}?token={apiKey}

Copy the exact URL from Deploy → Webhooks and add it to the external service. A successful request returns 202 Accepted with a run ID, and the resulting run appears in normal run history with webhook as its source.

The same deployment panel also shows outgoing completion callbacks. Pass an HTTPS URL as options.webhookUrl when starting a run, or configure it on a schedule, and superglue posts the result to that URL when the run finishes. Use tool:{toolId} instead to start another saved tool with the first tool’s output.

!

A webhook URL contains an API key in its query string. Treat the complete URL as a secret, scope the key to only the tools it needs, and rotate the key if the URL is exposed.

See Incoming Webhooks for provider setup, completion callbacks, and tool chaining.

MCP

Use MCP when an AI client should discover and run tools directly:

• The default /mcp endpoint exposes every active saved tool the authenticated identity can access.
• A custom MCP server exposes an explicit tool allowlist and can pin credentials for selected systems.
• OAuth lets each person act through their own superglue identity. Creator API key authentication is intended for trusted headless clients that act as the server creator.

The MCP tab in the Deploy dialog provides the default endpoint and client configuration. For a production or shared agent, create a custom server with only the tools it needs.

See Creating an MCP Server for endpoint formats, authentication, RBAC, and credential pinning.

Monitor deployed runs

Every deployment path creates a normal run record. Use Runs to inspect status, duration, source, step failures, and final output. For investigation from the CLI, use sg run list and sg run get <runId> --full.