Deploying a Tool

Once you’ve created a tool, you can deploy it in two ways: execute it on-demand when you need it, or schedule it to run automatically on a recurring basis.

On-demand execution

Run your tools immediately whenever you need them.

Via UI
Via SDK
Via GraphQL

Execute tools directly from the tool details page:

Navigate to your tool

Go to Tools in your dashboard and select the tool you want to run

Provide input data

Enter any required input parameters in JSON format. If your tool doesn’t require input, use {}

Execute

Click “Run” to execute immediately. You’ll see real-time logs and step-by-step progress

Review results

Check the output data and individual step results. All executions are logged for debugging.

For programmatic execution, use the SDK:

npm install @superglue/client

Execute a saved tool:

import { SuperglueClient } from "@superglue/client";

const superglue = new SuperglueClient({
  apiKey: "your_api_key_here",
  endpoint: "https://graphql.superglue.ai"
});

const result = await superglue.executeWorkflow({
  id: "sync-customers",
  payload: {
    startDate: "2025-01-01",
    userId: "user_123"
  }
});

if (result.success) {
  console.log(result.data); // Final output
  console.log(result.stepResults); // Step-by-step details
} else {
  console.error(result.error);
}

Execute with advanced options:

const result = await superglue.executeWorkflow({
  id: "sync-customers",
  payload: {},
  options: {
    selfHealing: "ENABLED",    // Auto-fix configuration errors
    retries: 3,                 // Retry failed steps up to 3 times
    timeout: 120000,            // 2 minute timeout
    webhookUrl: "https://example.com/webhook" // Send results to webhook URL
  }
});

Chain tools together:Trigger another tool when this one completes using the tool: prefix:

const result = await superglue.executeWorkflow({
  id: "sync-customers",
  payload: {},
  options: {
    webhookUrl: "tool:send-email-report" // Trigger another tool with results
  }
});

The output of the first tool becomes the payload for the chained tool. This enables powerful multi-stage workflows.Execute an inline workflow (without saving it):

const result = await superglue.executeWorkflow({
  workflow: {
    id: "temp-workflow",
    integrationIds: ["stripe"],
    steps: [
      {
        id: "getCustomers",
        integrationId: "stripe",
        apiConfig: {
          method: "GET",
          urlPath: "/v1/customers",
          queryParams: { limit: "100" }
        }
      }
    ],
    finalTransform: "(sourceData) => sourceData.getCustomers.data"
  },
  payload: {}
});

Execute tools using the GraphQL API:Endpoint: https://graphql.superglue.ai

mutation ExecuteWorkflow($input: WorkflowInputRequest!, $payload: JSON) {
  executeWorkflow(
    input: $input
    payload: $payload
    options: {
      selfHealing: ENABLED
      retries: 3
      timeout: 60000
    }
  ) {
    success
    data
    error
    stepResults {
      stepId
      success
      data
      error
    }
    startedAt
    completedAt
  }
}

Variables:

{
  "input": {
    "id": "sync-customers"
  },
  "payload": {
    "startDate": "2025-01-01"
  }
}

Headers:

Authorization: Bearer your_superglue_api_key
Content-Type: application/json

See API Reference for complete documentation.

Scheduled execution

Schedule tools to run automatically at specific times or intervals.

Via UI
Via SDK
Via GraphQL

Create schedules from the dashboard:

Open schedule modal

Navigate to your tool and click “Add Schedule”

Configure frequency

Choose from preset intervals (every 5 minutes, hourly, daily, weekly, monthly) or enter a custom cron expressionCommon cron examples:

*/5 * * * * - Every 5 minutes
0 9 * * 1-5 - Weekdays at 9 AM
0 0 1 * * - First day of every month
0 */6 * * * - Every 6 hours

Visit crontab.guru to build and validate cron expressions

Select timezone

Choose your timezone to ensure the schedule runs at the correct local time

Set input payload (optional)

Provide JSON input data that will be passed to each execution.

Configure advanced options (optional)

Expand “Advanced Options” to configure:

Self-Healing: Automatically fix API configuration errors
Retries: Number of retry attempts (0-10) for failed API calls
Timeout: Maximum execution time in milliseconds
Webhook: Send execution results to a URL or trigger another tool

Save and enable

Click “Add Schedule” to save. The schedule will start running at the next scheduled time. You can pause it anytime by toggling “Enable schedule” off.

Create and manage schedules programmatically:Create a schedule:

import { SuperglueClient } from "@superglue/client";

const superglue = new SuperglueClient({
  apiKey: "your_api_key_here",
  endpoint: "https://graphql.superglue.ai"
});

const schedule = await superglue.upsertWorkflowSchedule({
  workflowId: "sync-customers",
  cronExpression: "0 0 * * *",  // Daily at midnight
  timezone: "America/New_York",
  enabled: true,
  payload: {
    date: "<<(sourceData) => new Date().toISOString()>>",
    environment: "production"
  },
  options: {
    selfHealing: "ENABLED",
    retries: 3,
    timeout: 120000,
    webhookUrl: "https://example.com/webhook" // Send to external URL
  }
});

console.log(`Next run: ${schedule.nextRunAt}`);

Create a schedule that chains tools:

const schedule = await superglue.upsertWorkflowSchedule({
  workflowId: "sync-customers",
  cronExpression: "0 0 * * *",
  timezone: "America/New_York",
  enabled: true,
  payload: {},
  options: {
    webhookUrl: "tool:send-email-report" // Trigger another tool
  }
});

Manage schedules using GraphQL:Create a schedule:

mutation UpsertWorkflowSchedule($schedule: WorkflowScheduleInput!) {
  upsertWorkflowSchedule(schedule: $schedule) {
    id
    workflowId
    cronExpression
    timezone
    enabled
    nextRunAt
    lastRunAt
  }
}

Variables:

{
  "schedule": {
    "workflowId": "sync-customers",
    "cronExpression": "0 0 * * *",
    "timezone": "America/New_York",
    "enabled": true,
    "payload": {
      "environment": "production"
    },
    "options": {
      "selfHealing": "ENABLED",
      "retries": 3,
      "timeout": 120000,
      "webhookUrl": "https://example.com/webhook"
    }
  }
}

Getting Started

Guides

SDK Reference

API Reference

On-demand execution

Scheduled execution

Getting Started

Guides

SDK Reference

API Reference

​On-demand execution

​Scheduled execution

On-demand execution

Scheduled execution