> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Kadoa

The Kadoa connector lets your AI agent act in each user's Kadoa account. Each user connects their own Kadoa API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** API Key
**Categories:** Automation, Analytics
**Tools:** 60: 26 read, 27 write, 7 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=KADOA)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Kadoa connection

   In **AgentKit > Connections**, create a Kadoa connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'kadoa'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Kadoa:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'kadoa_changes_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "kadoa"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Kadoa:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="kadoa_changes_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Kadoa credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'kadoa_change_get',
  toolInput: {
    change_id: '<change_id>',
  },
  connector: 'kadoa',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="kadoa_change_get",
    tool_input={
        "change_id": "<change_id>",
    },
    connection_name="kadoa",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `kadoa_change_get`

Get Data Change · Read-only

Get one data change with its records, optionally only added, removed or changed ones, sorted and paged. Returns the change and its differing records. Use this to inspect a change from kadoa_changes_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `change_id` (`string`, required): ID of the data change. Example: 6a1f2c3d4e5f6a7b8c9d0e99.
- `exclude` (`string`, optional): Comma-separated fields to leave out of each change, e.g. data or differences. Example: data.
- `limit` (`integer`, optional): Maximum number of differences to return (maximum 100; larger values return 400). Without it, all differences are returned. Use differencesCounts for the totals. Example: 25.
- `order` (`string`, optional): Sort order: asc or desc. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `skip` (`integer`, optional): Number of items to skip, for paging. Example: 0.
- `sort_by` (`string`, optional): Field key to sort differences by; without it, differences are grouped by type. Example: createdAt.
- `type` (`string`, optional): Return only differences of this type. One of: added, removed, changed. Example: added. One of: `added`, `removed`, `changed`.

Example input: `{"change_id":"<change_id>"}`

### `kadoa_changes_list`

List Data Changes · Read-only

List the data changes Kadoa detected between runs of monitored workflows, optionally for some workflows and a date range. Returns per change its ID, workflow, date, and added, removed and changed records. Use this to track what changed on monitored sites. Use kadoa_change_get for one change.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, optional): Only changes on or before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
- `exclude` (`string`, optional): Comma-separated fields to leave out of each change, e.g. data or differences. Example: data.
- `limit` (`integer`, optional): Number of records to return (maximum 100; larger values return 400). Defaults to 25. Example: 25.
- `skip` (`integer`, optional): Number of items to skip, for paging. Example: 0.
- `start_date` (`string`, optional): Only changes on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `workflow_ids` (`string`, optional): Comma-separated workflow IDs to filter by. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{}`

### `kadoa_notification_channel_get`

Get Notification Channel · Read-only

Get one notification channel. Returns its name, type and config. Use this when you know the channel ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_id` (`string`, required): ID of the notification channel. Example: 6a1f2c3d4e5f6a7b8c9d0e66.
- `include_configurations` (`boolean`, optional): Set to true to include the channel's settings. Defaults to true. Example: true.

Example input: `{"channel_id":"<channel_id>"}`

### `kadoa_notification_channels_list`

List Notification Channels · Read-only

List notification channels (email, Slack, webhook, websocket), optionally those used by one workflow. Returns per channel its ID, name, type and config. Use this to find channel IDs for notification settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include_configurations` (`boolean`, optional): Set to true to include each channel's settings. Defaults to true. Example: true.
- `workflow_id` (`string`, optional): Only channels used by this workflow. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{}`

### `kadoa_notification_event_types_list`

List Notification Event Types · Read-only

List the event types you can be notified about, such as workflow_finished, workflow_failed and workflow_data_change. Returns each type with its description. Use this to choose an event for a notification setting.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `kadoa_notification_setting_get`

Get Notification Setting · Read-only

Get one notification setting. Returns its workflow, event type, enabled flag and channels. Use this when you know the setting ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `settings_id` (`string`, required): ID of the notification setting. Example: 6a1f2c3d4e5f6a7b8c9d0e88.

Example input: `{"settings_id":"<settings_id>"}`

### `kadoa_notification_settings_list`

List Notification Settings · Read-only

List notification settings, optionally for one workflow or event type. Returns per setting its ID, workflow, event type, enabled flag and channels. Use this to see who gets notified of what.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `event_type` (`string`, optional): Only settings for this event type. One of: workflow_started, workflow_finished, workflow_failed, workflow_sample_finished, workflow_data_change, system_maintenance, service_degradation, credits_low, free_trial_ending. Example: workflow_finished. One of: `workflow_started`, `workflow_finished`, `workflow_failed`, `workflow_sample_finished`, `workflow_data_change`, `system_maintenance`, `service_degradation`, `credits_low`, `free_trial_ending`.
- `workflow_id` (`string`, optional): Only settings of this workflow. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{}`

### `kadoa_schema_get`

Get Schema · Read-only

Get one extraction schema. Returns its name, entity and fields. Use this when you know the schema ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `schema_id` (`string`, required): ID of the schema. Find it with kadoa_schemas_list. Example: 6a1f2c3d4e5f6a7b8c9d0e33.

Example input: `{"schema_id":"<schema_id>"}`

### `kadoa_schemas_list`

List Schemas · Read-only

List the saved extraction schemas in your workspace. Returns per schema its ID, name, entity and fields. Use this to reuse a schema when creating workflows.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `kadoa_template_get`

Get Template · Read-only

Get one template with its versions. Returns name, description, versions and their prompt, schema and settings. Use this when you know the template ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.

Example input: `{"template_id":"<template_id>"}`

### `kadoa_template_schemas_list`

List Template Schemas · Read-only

List the schemas used by a template's versions. Returns schema IDs, names and fields. Use this to inspect a template's output.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.

Example input: `{"template_id":"<template_id>"}`

### `kadoa_template_workflows_list`

List Template Workflows · Read-only

List the workflows linked to a template and the version each uses. Returns workflow IDs, names and versions. Use this before applying a new version.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.

Example input: `{"template_id":"<template_id>"}`

### `kadoa_templates_list`

List Templates · Read-only

List workflow templates in your workspace. Returns per template its ID, name, description and latest version. Use this to find a template for kadoa_workflow_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `kadoa_workflow_audit_log_list`

List Workflow Audit Log · Read-only

List the audit log of a workflow: who changed, ran or paused it and when. Returns entries with user, action, timestamp and details. Use this to trace changes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `limit` (`integer`, optional): Number of items per page. Defaults to 25. Example: 25.
- `page` (`integer`, optional): Page number, starting at 1. Defaults to 1. Example: 1.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_connectors_list`

List Workflow Destinations · Read-only

List the destinations (connectors) that deliver a workflow's results, such as databases or storage. Returns per destination its ID, type and status. Use this to see where data goes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_data_get`

Get Workflow Data · Read-only

Get the records a workflow extracted, from the latest run or a specific run, with optional sorting, filters and paging. Returns the rows with their fields, plus pagination and run info. Use this to read scraped results. Use kadoa_changes_list for differences between runs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `filters` (`string`, optional): JSON array of filter conditions, each with field, operator and value. Example: [{"field":"price","operator":"gt","value":10}]
- `limit` (`integer`, optional): Number of items per page (0 for streaming all data). Defaults to 25. Example: 25.
- `order` (`string`, optional): Sort order: asc or desc. One of: asc, desc. Defaults to asc. Example: desc. One of: `asc`, `desc`.
- `page` (`integer`, optional): Page number, starting at 1. Defaults to 1. Example: 1.
- `row_ids` (`string`, optional): Comma-separated row IDs to return. Example: row_1,row_2.
- `run_id` (`string`, optional): ID of a specific run (job); leave empty for the latest run. Example: 6a1f2c3d4e5f6a7b8c9d0e55.
- `sort_by` (`string`, optional): Field to sort by. Example: createdAt.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_get`

Get Workflow · Read-only

Get one workflow by ID. Returns its name, URLs, prompt, schema (entity and fields), schedule, location, monitoring, state, run state, last run details and record counts. Use this when you know the workflow ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_history_list`

List Workflow Runs · Read-only

List the run history of a workflow, optionally by status or run ID. Returns per run its job ID, status, start and end time, record count and errors. Use this to check recent runs. Use kadoa_workflow_job_get for one run's telemetry.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `limit` (`integer`, optional): Maximum number of runs per page (default 25, min 1, max 1000). Example: 25.
- `page` (`integer`, optional): Page number, starting at 1. Defaults to 1. Example: 1.
- `run_id` (`string`, optional): ID of a specific run (job); leave empty for the latest run. Example: 6a1f2c3d4e5f6a7b8c9d0e55.
- `status` (`string`, optional): Filter runs by outcome. success maps to FINISHED, failed maps to FAILED, in_progress maps to RUNNING, stopped maps to STOPPED. One of: success, failed, in_progress, stopped. Example: success. One of: `success`, `failed`, `in_progress`, `stopped`.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_history_metrics_get`

Get Workflow Run Metrics · Read-only

Get aggregated run success metrics of a workflow over a number of days. Returns success and failure counts and rates. Use this to judge a workflow's reliability.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `days` (`integer`, optional): Number of past days to aggregate. Defaults to 30. Example: 30.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_job_get`

Get Workflow Run · Read-only

Get the status and telemetry of one workflow run (job). Returns state, timestamps, pages and records processed, credits used and errors. Use this to follow a run started with kadoa_workflow_run.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): ID of the workflow run (job), from kadoa_workflow_history_list. Example: 6a1f2c3d4e5f6a7b8c9d0e55.
- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"job_id":"<job_id>","workflow_id":"<workflow_id>"}`

### `kadoa_workflow_quality_metrics_get`

Get Workflow Quality Metrics · Read-only

Get data quality metrics of a workflow's latest run or a given run: field fill rates and validation-rule results. Returns the metrics per field. Use this to spot broken extractions.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `job_id` (`string`, optional): ID of the workflow run (job), from kadoa_workflow_history_list. Example: 6a1f2c3d4e5f6a7b8c9d0e55.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_rules_get`

Get Workflow Data Quality Rules · Read-only

Get the data quality (schema validation) rules of a workflow. Returns the rules per field. Use this before changing rules.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_sql_generate`

Generate Data Query · Read-only

Turn a natural-language question into a DuckDB SQL query over a workflow's data, given its column names and a few sample rows. Returns the SQL. Use this to help analyse scraped data; it does not run the query.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `columns` (`array`, required): Columns of the workflow data, each an object with name and type. Example: [{"name":"brand","type":"VARCHAR"},{"name":"price","type":"DOUBLE"}]
- `prompt` (`string`, required): Question to answer, in plain language. Example: Average price per brand.
- `sample_rows` (`array`, required): Up to 5 sample rows, each an array of string values in column order. Example: [["Acme","19.99"],["Globex","24.50"]]
- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"columns":[{"name":"brand","type":"VARCHAR"},{"name":"price","type":"DOUBLE"}],"prompt":"<prompt>","sample_rows":[],"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_trigger_get`

Get Workflow Trigger · Read-only

Get one trigger of a workflow. Returns its target workflow, event type and enabled flag. Use this when you know the trigger ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `trigger_id` (`string`, required): ID of the trigger. Example: 6a1f2c3d4e5f6a7b8c9d0e77.
- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"trigger_id":"<trigger_id>","workflow_id":"<workflow_id>"}`

### `kadoa_workflow_triggers_list`

List Workflow Triggers · Read-only

List the triggers of a workflow, which start another workflow when an event happens. Returns per trigger its ID, target workflow, event type and enabled flag. Use this to see workflow chains.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflows_list`

List Workflows · Read-only

List the workflows (scrapers) in your Kadoa workspace, filtered by search text, state, run state, tags, template, update interval or schedule type. Returns per workflow its ID, name, URLs, state, run state, schedule, tags, last run and record count, plus pagination. Use this to find a workflow. Use kadoa_workflow_get for one workflow's full configuration.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `display_state` (`string`, optional): Filter by the workflow's computed operational state. This does not include pending user input or support ownership; use statusFilters for those dashboard categories. Accepts comma-separated values. One of: ACTIVE, DRAFT, PAUSED, PREVIEW, FAILED, RUNNING, VALIDATING, INVESTIGATING, PENDING_START, COMPLIANCE_REVIEW, COMPLIANCE_REJECTED. Example: ACTIVE. One of: `ACTIVE`, `DRAFT`, `PAUSED`, `PREVIEW`, `FAILED`, `RUNNING`, `VALIDATING`, `INVESTIGATING`, `PENDING_START`, `COMPLIANCE_REVIEW`, `COMPLIANCE_REJECTED`.
- `include_deleted` (`boolean`, optional): Include deleted workflows (for compliance officers). Defaults to false. Example: false.
- `limit` (`integer`, optional): Maximum number of items to return. Defaults to 25. Example: 25.
- `monitoring` (`string`, optional): Filter workflows by monitoring status. One of: true, false. Example: true. One of: `true`, `false`.
- `run_state` (`string`, optional): Filter by the latest execution attempt. Use this for run diagnostics, not workflow status UI. One of: FAILED, FINISHED, RUNNING, STOPPED. Example: FINISHED. One of: `FAILED`, `FINISHED`, `RUNNING`, `STOPPED`.
- `schedule_type` (`string`, optional): Filter workflows by schedule type. RUN_ONCE = no recurring schedule (Complete), RECURRING = has a recurring/real-time schedule (Scheduled). One of: RUN_ONCE, RECURRING. Example: RECURRING. One of: `RUN_ONCE`, `RECURRING`.
- `search` (`string`, optional): Search term to filter workflows by name or workflow ID. Example: products.
- `skip` (`integer`, optional): Number of items to skip, for paging. Defaults to 0. Example: 0.
- `state` (`string`, optional): Filter by the persisted state of the long-lived workflow. Use displayState for its computed operational status, statusFilters for dashboard categories, and inSupport for support ownership. DRAFT workflows are excluded by default unless explicitly requested. One of: ACTIVE, DRAFT, PAUSED, PREVIEW, QUEUED, SETUP, COMPLIANCE_REVIEW, COMPLIANCE_REJECTED, NOT_SUPPORTED, ERROR, DELETED. Example: ACTIVE. One of: `ACTIVE`, `DRAFT`, `PAUSED`, `PREVIEW`, `QUEUED`, `SETUP`, `COMPLIANCE_REVIEW`, `COMPLIANCE_REJECTED`, `NOT_SUPPORTED`, `ERROR`, `DELETED`.
- `tags` (`array`, optional): Tags to filter by. Example: ["pricing"]
- `template_id` (`array`, optional): Template IDs to filter by. Example: ["6a1f2c3d4e5f6a7b8c9d0e44"]
- `update_interval` (`string`, optional): Filter workflows by update interval. REAL_TIME matches workflows that run in real time, independent of notification configuration. One of: HOURLY, DAILY, WEEKLY, MONTHLY, REAL_TIME. Example: DAILY. One of: `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`, `REAL_TIME`.

Example input: `{}`

### `kadoa_notification_channel_create`

Create Notification Channel · Write

Create a notification channel (EMAIL, SLACK, WEBHOOK or WEBSOCKET) or reuse an identical one. Returns the channel. Use kadoa_notification_setting_create to send events to it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `channel_type` (`string`, required): Channel type. One of: EMAIL, SLACK, WEBHOOK, WEBSOCKET. Example: WEBHOOK. One of: `EMAIL`, `SLACK`, `WEBHOOK`, `WEBSOCKET`.
- `config` (`object`, required): Channel settings: for EMAIL {"recipients": [emails]}, for SLACK {"webhookUrl": url}, for WEBHOOK {"webhookUrl": url, "httpMethod": "POST"}. Example: {"webhookUrl":"https://example.com/kadoa","httpMethod":"POST"}
- `name` (`string`, required): Channel name. Example: sk-test product prices.

Example input: `{"channel_type":"EMAIL","config":{"webhookUrl":"https://example.com/kadoa","httpMethod":"POST"},"name":"<name>"}`

### `kadoa_notification_channel_update`

Update Notification Channel · Write

Replace a notification channel's name, type and config. Returns the updated channel. Use this to change recipients or a webhook URL.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_id` (`string`, required): ID of the notification channel. Example: 6a1f2c3d4e5f6a7b8c9d0e66.
- `channel_type` (`string`, required): Channel type. One of: EMAIL, SLACK, WEBHOOK, WEBSOCKET. Example: WEBHOOK. One of: `EMAIL`, `SLACK`, `WEBHOOK`, `WEBSOCKET`.
- `config` (`object`, required): Channel settings: for EMAIL {"recipients": [emails]}, for SLACK {"webhookUrl": url}, for WEBHOOK {"webhookUrl": url, "httpMethod": "POST"}. Example: {"webhookUrl":"https://example.com/kadoa","httpMethod":"POST"}
- `name` (`string`, required): Channel name. Example: sk-test product prices.

Example input: `{"channel_id":"<channel_id>","channel_type":"EMAIL","config":{"webhookUrl":"https://example.com/kadoa","httpMethod":"POST"},"name":"<name>"}`

### `kadoa_notification_setting_create`

Create Notification Setting · Write

Send an event type to one or more channels, for one workflow or the whole workspace. Returns the new setting. Use kadoa_notification_channel_create first to get channel IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `event_configuration` (`object`, required): Event-specific settings; pass {} today. Example: {}
- `event_type` (`string`, required): Event to notify about. One of: workflow_started, workflow_finished, workflow_failed, workflow_sample_finished, workflow_data_change, system_maintenance, service_degradation, credits_low, free_trial_ending. Example: workflow_finished. One of: `workflow_started`, `workflow_finished`, `workflow_failed`, `workflow_sample_finished`, `workflow_data_change`, `system_maintenance`, `service_degradation`, `credits_low`, `free_trial_ending`.
- `channel_ids` (`array`, optional): IDs of the notification channels to deliver to. Example: ["6a1f2c3d4e5f6a7b8c9d0e66"]
- `enabled` (`boolean`, optional): Set to false to create it disabled. Example: true.
- `workflow_id` (`string`, optional): Workflow to watch; leave empty for a workspace-wide setting. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"event_configuration":{},"event_type":"workflow_started"}`

### `kadoa_notification_setting_update`

Update Notification Setting · Write

Change a notification setting's event type, channels or enabled flag. Returns the updated setting. Use this to pause a notification or reroute it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `settings_id` (`string`, required): ID of the notification setting. Example: 6a1f2c3d4e5f6a7b8c9d0e88.
- `channel_ids` (`array`, optional): IDs of the notification channels to deliver to. Example: ["6a1f2c3d4e5f6a7b8c9d0e66"]
- `enabled` (`boolean`, optional): true to enable, false to disable. Example: true.
- `event_configuration` (`object`, optional): Event-specific settings; pass {} today. Example: {}
- `event_type` (`string`, optional): Event to notify about. One of: workflow_started, workflow_finished, workflow_failed, workflow_sample_finished, workflow_data_change, system_maintenance, service_degradation, credits_low, free_trial_ending. Example: workflow_finished. One of: `workflow_started`, `workflow_finished`, `workflow_failed`, `workflow_sample_finished`, `workflow_data_change`, `system_maintenance`, `service_degradation`, `credits_low`, `free_trial_ending`.
- `expected_channel_ids` (`array`, optional): Channel IDs you expect the setting to have now; the update fails if they differ (optimistic check). Example: ["6a1f2c3d4e5f6a7b8c9d0e66"]

Example input: `{"settings_id":"<settings_id>"}`

### `kadoa_schema_create`

Create Schema · Write

Create a reusable extraction schema with an entity name and fields. Returns the new schema ID. Use it with kadoa_workflow_create (schema_id).

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `fields` (`array`, required): Fields to extract. Each needs a name, a description, a dataType (STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, ARRAY) and an example value. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"},{"name":"price","description":"Price in USD","dataType":"MONEY...
- `name` (`string`, required): Name of the schema. Example: sk-test product prices.
- `entity` (`string`, optional): Entity name, e.g. Product. Example: Product.

Example input: `{"fields":[],"name":"<name>"}`

### `kadoa_schema_update`

Update Schema · Write

Update a schema's name, entity or fields. Returns the updated schema. Use this to change what workflows using it extract.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `schema_id` (`string`, required): ID of the schema. Find it with kadoa_schemas_list. Example: 6a1f2c3d4e5f6a7b8c9d0e33.
- `entity` (`string`, optional): Entity name, e.g. Product. Example: Product.
- `fields` (`array`, optional): Fields to extract. Each needs a name, a description, a dataType (STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, ARRAY) and an example value. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"},{"name":"price","description":"Price in USD","dataType":"MONEY...
- `name` (`string`, optional): Name of the schema. Example: sk-test product prices.

Example input: `{"schema_id":"<schema_id>"}`

### `kadoa_scrape`

Scrape URL · Write

Fetch one URL through Kadoa's proxies and optional headless browser and return its content, as HTML or as markdown for LLMs, with options for method, headers, body, geo location, device, wait conditions, browser actions and captured network responses. Uses account credits. Returns the status code, final URL, headers and page content. Use this for a one-off fetch. Use kadoa_workflow_create for structured, repeated extraction.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `url` (`string`, required): URL to fetch. Example: https://example.com/products.
- `browser_actions` (`array`, optional): Browser actions to run before capturing, e.g. clicks, typing, scrolling and waits. Example: [{"type":"click","selector":"#load-more"}]
- `capture_responses` (`array`, optional): Substrings matched against network response URLs (browser workers only). The worker hooks every response the page makes and returns the body of each whose URL contains any of these substrings, in capturedResponses. Use this to read data that arrives via XHR/fetch and is NOT in the DOM — SPA dashboards (Tableau VizQL, Power BI) where values come back in a JSON/command response. Triggers a browser worker; pair with browserActions (clicks/waits) to drive the requests you want captured. Example: ["/api/products"]
- `context` (`object`, optional): Sticky proxy session, e.g. {"sessionId": "sess-1"}. Example: {"sessionId":"sess-1"}
- `device` (`string`, optional): Device to emulate, by descriptor name (e.g. 'iPad', 'iPhone 13'). Honored by workers that support device emulation; ignored by the rest. Some sites only serve content for a given device profile. Example: iPhone 13.
- `fetch_mode` (`string`, optional): Fetch mode: http for fast requests, browser for JavaScript rendering and browser actions, or auto for smart routing that starts cheap and escalates when blocked. Default: auto. One of: http, browser, auto. Example: auto. One of: `http`, `browser`, `auto`.
- `format` (`string`, optional): Content format for HTML pages. markdown converts the page to markdown with navigation, header, and footer stripped — the compact shape to feed an LLM. Non-HTML responses (JSON, binary) and HTML pages over 2 MB are returned unchanged; check the response contentType to see which format was applied. Default: html. One of: html, markdown. Example: markdown. One of: `html`, `markdown`.
- `headers` (`array`, optional): Request headers, each an object with name and value. Example: [{"name":"Accept-Language","value":"en-US"}]
- `location` (`object`, optional): Geo-targeting for the proxy, e.g. {"type": "manual", "isoCode": "US"}. Example: {"type":"manual","isoCode":"US"}
- `method` (`string`, optional): HTTP method. Default: GET. One of: GET, POST, PUT, DELETE, PATCH. Example: GET. One of: `GET`, `POST`, `PUT`, `DELETE`, `PATCH`.
- `overall_timeout` (`integer`, optional): Wall-clock deadline for the complete scrape in milliseconds. Default and maximum: 240000. Example: 120000.
- `proxy` (`string`, optional): Proxy tier: auto (smart selection), direct (Squid server egress without location guarantees), dc (datacenter), isp, residential, or stealth to route through the anti-bot providers for sites that block bots. Stealth providers use their own egress and pricing. Default: auto. One of: auto, direct, dc, isp, residential, stealth. Example: auto. One of: `auto`, `direct`, `dc`, `isp`, `residential`, `stealth`.
- `raw_body` (`string`, optional): Exact request body text to forward to the upstream URL. Use for endpoints that reject wrapper objects or require a specific JSON/form payload string. Example: {"q":"laptop"}
- `settle_ms` (`integer`, optional): Browser-worker cap (ms) for the best-effort networkidle settle after domcontentloaded. Default 15000. Raise for slow client-rendered pages that need more time for lazy content; lower to return faster. Ignored when waitUntil: networkidle and for non-browser workers. Example: 15000.
- `timeout` (`integer`, optional): Per-attempt timeout in milliseconds. Example: 30000.
- `wait_until` (`string`, optional): Browser-worker navigation gate. Default (omitted) is domcontentloaded + a bounded best-effort networkidle settle, which returns content even on heavy pages that never go fully idle (ASP.NET, SignalR, ad/telemetry-heavy). Set networkidle to block the whole navigation on full idle (old behavior — only when the page reliably goes idle and you need every lazy request). No-op for non-browser workers. One of: load, domcontentloaded, networkidle, commit. Example: networkidle. One of: `load`, `domcontentloaded`, `networkidle`, `commit`.

Example input: `{"url":"<url>"}`

### `kadoa_template_apply`

Apply Template Version · Write

Update linked workflows to a given template version. Returns per workflow whether it was updated. Use this after kadoa_template_version_publish.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `target_version` (`integer`, required): Template version number to apply. Example: 2.
- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
- `workflow_ids` (`array`, required): IDs of the linked workflows to update. Example: ["6a1f2c3d4e5f6a7b8c9d0e1f"]

Example input: `{"target_version":2,"template_id":"<template_id>","workflow_ids":["6a1f2c3d4e5f6a7b8c9d0e1f"]}`

### `kadoa_template_create`

Create Template · Write

Create an empty workflow template with a name and description. Returns the new template ID. Use kadoa_template_version_publish to give it a prompt and schema, or kadoa_template_from_workflow to start from a workflow.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Template name. Example: sk-test product prices.
- `description` (`string`, optional): Template description. Example: Daily prices of laptops on example.com.

Example input: `{"name":"<name>"}`

### `kadoa_template_duplicate`

Duplicate Template · Write

Duplicate a template under a new name. Returns the new template. Use this to start a variant.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
- `name` (`string`, optional): Name of the copy. Example: sk-test product prices.

Example input: `{"template_id":"<template_id>"}`

### `kadoa_template_from_workflow`

Save Workflow as Template · Write

Save a workflow's prompt, schema and settings as a new template, or as a new version of an existing template. Returns the template and version. Use this to reuse a working scraper for other sites.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `description` (`string`, optional): Description for a new template. Example: Daily prices of laptops on example.com.
- `include_parts` (`array`, optional): Parts of the workflow to copy, e.g. prompt, schema, notifications. Example: ["prompt","schema"]
- `name` (`string`, optional): Name for a new template. Example: sk-test product prices.
- `template_id` (`string`, optional): Existing template to add a version to; leave empty to create a new template. Example: 6a1f2c3d4e5f6a7b8c9d0e44.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_template_link`

Link Workflows to Template · Write

Link existing workflows to a template so template versions can be applied to them. Returns the linked workflows. Use kadoa_template_unlink to detach them.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
- `workflow_ids` (`array`, required): Workflow IDs. Example: ["6a1f2c3d4e5f6a7b8c9d0e1f"]
- `force` (`boolean`, optional): Set to true to link even if a workflow is already linked to another template. Example: false.

Example input: `{"template_id":"<template_id>","workflow_ids":["6a1f2c3d4e5f6a7b8c9d0e1f"]}`

### `kadoa_template_unlink`

Unlink Workflows from Template · Write

Detach workflows from a template; they keep their current configuration. Returns the unlinked workflows. Use kadoa_template_link to link them again.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
- `workflow_ids` (`array`, required): Workflow IDs. Example: ["6a1f2c3d4e5f6a7b8c9d0e1f"]

Example input: `{"template_id":"<template_id>","workflow_ids":["6a1f2c3d4e5f6a7b8c9d0e1f"]}`

### `kadoa_template_update`

Update Template · Write

Rename a template or change its description. Returns the updated template. Use kadoa_template_version_publish to change its content.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
- `description` (`string`, optional): Template description. Example: Daily prices of laptops on example.com.
- `name` (`string`, optional): Template name. Example: sk-test product prices.

Example input: `{"template_id":"<template_id>"}`

### `kadoa_template_version_publish`

Publish Template Version · Write

Publish a new version of a template with a prompt, a schema (schema ID or inline fields and entity), validation rules, notifications, frequency and record limit. Returns the new version number. Use kadoa_template_apply to roll it out to linked workflows.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
- `frequency` (`object`, optional): Run frequency, e.g. {"interval": "DAILY"}. Example: {"interval":"DAILY"}
- `notifications` (`array`, optional): Notification settings to apply to workflows. Example: []
- `prompt` (`string`, optional): Extraction instructions for the template. Example: Extract every product with title and price.
- `record_limit` (`integer`, optional): Maximum records per run. Example: 100.
- `record_limit_managed` (`boolean`, optional): true to let the template manage the record limit. Example: false.
- `schema_entity` (`string`, optional): Entity name for the inline schema. Example: Product.
- `schema_fields` (`array`, optional): Inline schema fields; same shape as fields on kadoa_schema_create. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"}]
- `schema_id` (`string`, optional): ID of the schema. Find it with kadoa_schemas_list. Example: 6a1f2c3d4e5f6a7b8c9d0e33.
- `schema_validation_rules` (`object`, optional): Data quality rules per field. Example: {}

Example input: `{"template_id":"<template_id>"}`

### `kadoa_workflow_compliance_approve`

Approve Workflow (Compliance) · Write

Approve a workflow that is waiting for compliance review so it can run. Returns the updated workflow. Use kadoa_workflow_compliance_reject to reject it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_compliance_reject`

Reject Workflow (Compliance) · Write

Reject a workflow that is waiting for compliance review, with a reason. Returns the updated workflow. Use kadoa_workflow_compliance_approve to approve it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reason` (`string`, required): Why the workflow is rejected. Example: Scrapes personal data that we are not allowed to collect.
- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"reason":"<reason>","workflow_id":"<workflow_id>"}`

### `kadoa_workflow_create`

Create Workflow · Write

Create a scraping workflow for one website from natural-language instructions (user_prompt), an existing schema (schema_id), an inline entity and fields, or a template (template_id). Kadoa builds the scraper, runs a preview and then runs it on the chosen interval; extraction uses account credits. Returns the new workflow ID. Use kadoa_workflow_run to run it again and kadoa_workflow_data_get to read results.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `urls` (`array`, required): Source URLs to scrape. Several URLs must belong to one website. Example: ["https://example.com/products"]
- `bypass_preview` (`boolean`, optional): Set to true to skip the preview and deploy immediately. Example: false.
- `description` (`string`, optional): What the workflow does, up to 500 characters. Example: Daily prices of laptops on example.com.
- `entity` (`string`, optional): Entity name to extract, used with fields, e.g. Product or JobListing. Example: Product.
- `fields` (`array`, optional): Fields to extract. Each needs a name, a description, a dataType (STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, ARRAY) and an example value. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"},{"name":"price","description":"Price in USD","dataType":"MONEY...
- `interval` (`string`, optional): How often to run. Example: DAILY. One of: `ONLY_ONCE`, `EVERY_10_MINUTES`, `EVERY_20_MINUTES`, `HALF_HOURLY`, `HOURLY`, `TWO_HOURLY`, `THREE_HOURLY`, `FOUR_HOURLY`, `SIX_HOURLY`, `TWELVE_HOURLY`, `EIGHTEEN_HOURLY`, `DAILY`, `TWO_DAY`, `THREE_DAY`, `WEEKLY`, `BIWEEKLY`, `TRIWEEKLY`, `FOUR_WEEKS`, `MONTHLY`, `CUSTOM`.
- `limit` (`integer`, optional): Maximum number of items to scrape per run. Example: 100.
- `location` (`object`, optional): Geo location for scraping: {"type": "auto"} or {"type": "manual", "isoCode": "US"}. Example: {"type":"manual","isoCode":"US"}
- `name` (`string`, optional): Human-readable workflow name. Example: sk-test laptop prices.
- `schedules` (`array`, optional): Cron expressions for a custom schedule; they override interval. Example: ["0 9 * * 1-5"]
- `schema_id` (`string`, optional): ID of an existing schema to extract (from kadoa_schemas_list). Example: 6a1f2c3d4e5f6a7b8c9d0e33.
- `tags` (`array`, optional): Tags for organising workflows (at least 2 characters each). Example: ["pricing"]
- `template_id` (`string`, optional): ID of a published template to instantiate (from kadoa_templates_list). Example: 6a1f2c3d4e5f6a7b8c9d0e44.
- `timezone` (`string`, optional): IANA time zone for the cron schedules; defaults to UTC. Example: America/New_York.
- `user_prompt` (`string`, optional): Natural-language instructions (10 to 5000 characters) describing what to extract. Give this, schema_id, entity with fields, or template_id. Example: Extract every laptop with its title, price and rating.

Example input: `{"urls":["https://example.com/products"]}`

### `kadoa_workflow_metadata_update`

Update Workflow · Write

Update a workflow's name, description, tags, URLs, prompt, schema fields, item limit, update interval, schedules, time zone, location or monitoring; fields you leave out are unchanged. Returns the updated workflow. Use this to edit a workflow.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `description` (`string`, optional): The new description for the workflow. Example: Daily prices of laptops on example.com.
- `entity` (`string`, optional): The new entity for the workflow. Example: Product.
- `limit` (`integer`, optional): Maximum records per run. Pass null to clear the limit and extract all rows. Example: 25.
- `location` (`object`, optional): The new location for the workflow. Example: {"type":"manual","isoCode":"US"}
- `monitoring` (`object`, optional): The monitoring config for the workflow. Example: {"enabled":true}
- `name` (`string`, optional): The new name for the workflow. Example: sk-test product prices.
- `schedules` (`array`, optional): Array of cron expressions for the workflow schedule. Example: ["0 9 * * 1-5"]
- `schema` (`array`, optional): The new extraction schema for the workflow. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"}]
- `tags` (`array`, optional): The tags for the workflow. Example: ["pricing"]
- `timezone` (`string`, optional): IANA timezone for cron schedules. A timezone-only update preserves existing cron expressions. Example: America/New_York.
- `update_interval` (`string`, optional): The new update interval for the workflow. One of: ONLY_ONCE, EVERY_10_MINUTES, HALF_HOURLY, HOURLY, THREE_HOURLY, SIX_HOURLY, TWELVE_HOURLY, EIGHTEEN_HOURLY, DAILY, TWO_DAY, THREE_DAY, WEEKLY, BIWEEKLY, TRIWEEKLY, FOUR_WEEKS, MONTHLY, CUSTOM. Example: DAILY. One of: `ONLY_ONCE`, `EVERY_10_MINUTES`, `HALF_HOURLY`, `HOURLY`, `THREE_HOURLY`, `SIX_HOURLY`, `TWELVE_HOURLY`, `EIGHTEEN_HOURLY`, `DAILY`, `TWO_DAY`, `THREE_DAY`, `WEEKLY`, `BIWEEKLY`, `TRIWEEKLY`, `FOUR_WEEKS`, `MONTHLY`, `CUSTOM`.
- `urls` (`array`, optional): List of target URLs for the workflow. Example: ["https://example.com/products"]
- `user_prompt` (`string`, optional): Natural language instructions for the workflow. Example: Extract every laptop with its title, price and rating.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_pause`

Pause Workflow · Write

Pause a workflow's schedule. Returns the updated state. Use kadoa_workflow_resume to restart it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_resume`

Resume Workflow · Write

Resume a paused workflow's schedule. Returns the updated state. Use kadoa_workflow_pause to pause it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_run`

Run Workflow · Write

Start a run of a workflow now, optionally with variables, an item limit or as a preview; uses account credits. Returns the run (job) ID. Use kadoa_workflow_job_get to follow progress and kadoa_workflow_data_get for results.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `limit` (`number`, optional): Optional limit for the number of records to process. Example: 25.
- `preview` (`boolean`, optional): Rerun the preview of a PREVIEW-state workflow instead of starting a production run. Example: true.
- `variables` (`object`, optional): Optional variables to pass to the workflow execution. Example: {"category":"laptops"}

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_schedule`

Schedule Workflow Run · Write

Schedule a single run of a workflow at a date and time. Returns the scheduled workflow. Use kadoa_workflow_run to run it now.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `date` (`string`, optional): ISO 8601 date and time of the run. Example: 2026-07-01T09:00:00Z.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_stop`

Stop Workflow Run · Write

Stop the run of a workflow that is in progress. Returns the updated run state. Use this to cancel a long or mistaken run.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_trigger_create`

Create Workflow Trigger · Write

Create a trigger that starts a target workflow when this workflow emits an event (for example when it finishes). Returns the new trigger. Use this to chain workflows.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `event_type` (`string`, required): Event of this workflow that fires the trigger, e.g. workflow_finished. One of: workflow_started, workflow_finished, workflow_export_completed, workflow_failed, workflow_recovered, workflow_sample_finished, workflow_data_change, workflow_data_quality_change, workflow_health_degraded. Example: workflow_finished. One of: `workflow_started`, `workflow_finished`, `workflow_export_completed`, `workflow_failed`, `workflow_recovered`, `workflow_sample_finished`, `workflow_data_change`, `workflow_data_quality_change`, `workflow_health_degraded`.
- `target_workflow_id` (`string`, required): ID of the workflow to start. Example: 6a1f2c3d4e5f6a7b8c9d0e20.
- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `enabled` (`boolean`, optional): Set to false to create it disabled. Example: true.

Example input: `{"event_type":"workflow_started","target_workflow_id":"<target_workflow_id>","workflow_id":"<workflow_id>"}`

### `kadoa_workflow_trigger_update`

Update Workflow Trigger · Write

Change a trigger's event type or enable or disable it. Returns the updated trigger. Use this to pause a workflow chain.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `trigger_id` (`string`, required): ID of the trigger. Example: 6a1f2c3d4e5f6a7b8c9d0e77.
- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
- `enabled` (`boolean`, optional): true to enable, false to disable. Example: true.
- `event_type` (`string`, optional): Event that fires the trigger. One of: workflow_started, workflow_finished, workflow_export_completed, workflow_failed, workflow_recovered, workflow_sample_finished, workflow_data_change, workflow_data_quality_change, workflow_health_degraded. Example: workflow_finished. One of: `workflow_started`, `workflow_finished`, `workflow_export_completed`, `workflow_failed`, `workflow_recovered`, `workflow_sample_finished`, `workflow_data_change`, `workflow_data_quality_change`, `workflow_health_degraded`.

Example input: `{"trigger_id":"<trigger_id>","workflow_id":"<workflow_id>"}`

### `kadoa_workflows_bulk_action`

Bulk Workflow Action · Write

Run, pause, resume, stop, delete, approve or tag up to 50 workflows at once. Returns per workflow whether the action succeeded. Use this for batch changes; the single-workflow tools cover one at a time.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `action` (`string`, required): The action to perform on all workflows. One of: run, pause, resume, stop, delete, approve, assignTags. Example: pause. One of: `run`, `pause`, `resume`, `stop`, `delete`, `approve`, `assignTags`.
- `workflow_ids` (`array`, required): IDs of up to 50 workflows. Example: ["6a1f2c3d4e5f6a7b8c9d0e1f"]
- `params` (`object`, optional): Action-specific parameters, e.g. {"tags": ["q3"]} for assignTags. Example: {"tags":["q3"]}

Example input: `{"action":"run","workflow_ids":["6a1f2c3d4e5f6a7b8c9d0e1f"]}`

### `kadoa_notification_channel_delete`

Delete Notification Channel · Destructive

Delete a notification channel. Returns a success message. Settings that used it stop delivering there.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `channel_id` (`string`, required): ID of the notification channel. Example: 6a1f2c3d4e5f6a7b8c9d0e66.

Example input: `{"channel_id":"<channel_id>"}`

### `kadoa_notification_setting_delete`

Delete Notification Setting · Destructive

Delete a notification setting. Returns a success message. Use this to stop a notification.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `settings_id` (`string`, required): ID of the notification setting. Example: 6a1f2c3d4e5f6a7b8c9d0e88.

Example input: `{"settings_id":"<settings_id>"}`

### `kadoa_schema_delete`

Delete Schema · Destructive

Delete an extraction schema. Returns a success message. Use this to remove a schema no workflow needs.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `schema_id` (`string`, required): ID of the schema. Find it with kadoa_schemas_list. Example: 6a1f2c3d4e5f6a7b8c9d0e33.

Example input: `{"schema_id":"<schema_id>"}`

### `kadoa_template_delete`

Archive Template · Destructive

Archive a template so it can no longer be used for new workflows. Returns a success message. Linked workflows keep running.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.

Example input: `{"template_id":"<template_id>"}`

### `kadoa_workflow_delete`

Delete Workflow · Destructive

Delete a workflow and stop its schedule. Returns a success message. Use kadoa_workflow_pause to stop it temporarily instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"workflow_id":"<workflow_id>"}`

### `kadoa_workflow_rule_delete`

Delete Workflow Field Rules · Destructive

Delete the data quality rules of one field of a workflow. Returns a success message. Use kadoa_workflow_rules_get to see the rules first.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `field_name` (`string`, required): Name of the field whose rules to delete. Example: price.
- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"field_name":"<field_name>","workflow_id":"<workflow_id>"}`

### `kadoa_workflow_trigger_delete`

Delete Workflow Trigger · Destructive

Delete a trigger of a workflow. Returns a success message. Use kadoa_workflow_trigger_update to disable it instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `trigger_id` (`string`, required): ID of the trigger. Example: 6a1f2c3d4e5f6a7b8c9d0e77.
- `workflow_id` (`string`, required): ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.

Example input: `{"trigger_id":"<trigger_id>","workflow_id":"<workflow_id>"}`

## Related

Other Automation connectors ([all 91](/agentkit/connectors/?category=automation)):

- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twilio](/agentkit/connectors/twilio/): Scalekit connector, Username and password, 61 tools
- [Stripe](/agentkit/connectors/stripe/): Scalekit connector, Access token, 178 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
