### Run Zapier SDK Examples

Source: https://github.com/zapier/sdk/blob/main/examples/README.md

Commands to install the SDK, authenticate, execute a plain script, and deploy a durable workflow.

```bash
npm install @zapier/zapier-sdk
npx zapier-sdk login

# Run a plain single-action script
npx tsx examples/by-app/notion/find-page-by-title.ts

# Deploy a durable workflow
cd examples/by-pattern/notify-on-event/stripe-charge-to-onboarding
npm install
npx zapier-sdk publish-workflow-version --file workflow.ts
```

--------------------------------

### Install Zapier SDK and CLI

Source: https://github.com/zapier/sdk/blob/main/AGENTS.md

Commands to install the SDK, development dependencies, and authenticate the CLI.

```bash
npm install @zapier/zapier-sdk
npm install -D @zapier/zapier-sdk-cli @types/node typescript
npx zapier-sdk login
```

--------------------------------

### Install Zapier SDK and authenticate

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/SKILL.md

Commands to install the necessary SDK packages and initiate the browser-based login process.

```bash
# SDK library.
npm install @zapier/zapier-sdk

# CLI plus TypeScript dev deps.
npm install -D @zapier/zapier-sdk-cli @types/node typescript

# Authenticate (opens a browser).
npx zapier-sdk login
```

--------------------------------

### Install Zapier SDK for GitHub Copilot CLI

Source: https://github.com/zapier/sdk/blob/main/README.md

Commands to add the marketplace and install the Zapier SDK plugin using the GitHub Copilot CLI.

```bash
copilot plugin marketplace add zapier/marketplace
copilot plugin install sdk@zapier
```

--------------------------------

### Install Zapier SDK dependencies

Source: https://github.com/zapier/sdk/blob/main/README.md

Install the core SDK and necessary development dependencies.

```bash
npm install @zapier/zapier-sdk
npm install -D @zapier/zapier-sdk-cli @types/node typescript
```

--------------------------------

### CLI Setup and Authentication

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli.md

Commands to authenticate the CLI and verify the current user profile.

```bash
npx zapier-sdk login                             # Opens browser, stores credentials locally.
npx zapier-sdk get-profile                       # Confirm auth is working.
```

--------------------------------

### Discovery flow commands for FollowUpBoss app

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/follow-up-boss/README.md

Run these commands to explore the app's available actions and input schemas at runtime. Includes listing apps, getting app metadata, listing actions with optional type filters, getting action definitions, listing input fields, and managing connections.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app follow-up-boss

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions follow-up-boss
npx zapier-sdk list-actions follow-up-boss --action-type write
npx zapier-sdk list-actions follow-up-boss --action-type read
npx zapier-sdk list-actions follow-up-boss --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action follow-up-boss <action-type> <action-key>
npx zapier-sdk list-action-input-fields follow-up-boss <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections follow-up-boss
npx zapier-sdk create-connection follow-up-boss   # human completes OAuth
```

--------------------------------

### Install Zapier SDK for OpenAI Codex

Source: https://github.com/zapier/sdk/blob/main/README.md

Commands to add the marketplace and install the Zapier SDK plugin using the codex CLI.

```bash
codex plugin marketplace add zapier/marketplace
codex plugin add sdk@zapier
```

--------------------------------

### Run WooCommerce actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/woocommerce/README.md

Examples for creating and searching for WooCommerce orders using the CLI.

```bash
# Create a new WooCommerce order with customer details and products.
npx zapier-sdk run-action woocommerce write orderCreate --connection <connection-id> \
  --inputs '{}'

# Find an order by searching with customer email or order number.
npx zapier-sdk run-action woocommerce search orderSearch --connection <connection-id> \
  --inputs '{}'
```

--------------------------------

### Run Todoist actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/todoist/README.md

Examples of creating a task and searching for a project using the run-action command.

```bash
# Create a new task in Todoist.
npx zapier-sdk run-action todoist write new_task --connection <connection-id> \
  --inputs '{"content":"Draft Q3 OKRs","note":"Discuss with leadership before finalizing.","date_string":"tomorrow at 9am","priority":1}'

# Find a project by name in Todoist.
npx zapier-sdk run-action todoist search find_project --connection <connection-id> \
  --inputs '{"name":"Product Launch"}'
```

--------------------------------

### Discovery flow commands for JiraSoftwareCloud

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/jira-software-cloud/README.md

Run these commands to explore the app's available actions and input schemas at runtime. Includes listing apps, getting app metadata, listing actions (optionally filtered by type), getting action definitions and input fields, and managing connections.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app jira-software-cloud

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions jira-software-cloud
npx zapier-sdk list-actions jira-software-cloud --action-type write
npx zapier-sdk list-actions jira-software-cloud --action-type read
npx zapier-sdk list-actions jira-software-cloud --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action jira-software-cloud <action-type> <action-key>
npx zapier-sdk list-action-input-fields jira-software-cloud <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections jira-software-cloud
npx zapier-sdk create-connection jira-software-cloud   # human completes OAuth
```

--------------------------------

### Discovery flow commands for Monday app

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/monday/README.md

Run these commands to explore the Monday app's available actions and input schemas at runtime. Includes listing apps, getting app metadata, listing actions by type, getting action definitions and input fields, and managing connections.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app monday

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions monday
npx zapier-sdk list-actions monday --action-type write
npx zapier-sdk list-actions monday --action-type read
npx zapier-sdk list-actions monday --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action monday <action-type> <action-key>
npx zapier-sdk list-action-input-fields monday <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections monday
npx zapier-sdk create-connection monday   # human completes OAuth
```

--------------------------------

### CLI examples for FollowUpBoss actions

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/follow-up-boss/README.md

Create a new deal for a contact and find a contact by name or email address using the CLI.

```bash
# Create a new deal for a contact.
npx zapier-sdk run-action follow-up-boss write create_deal --connection <connection-id> \
  --inputs '{"person":"john.smith@example.com","name":"Home Purchase - Maple Ave","teamMembers":"jane.agent@example.com","description":"Residential home purchase for John Smith on Maple Ave.","projectedCloseDate":"2024-08-15"}'
```

```bash
# Find a contact by name or email address.
npx zapier-sdk run-action follow-up-boss search find_contact --connection <connection-id> \
  --inputs '{"person":"john.smith@example.com"}'
```

--------------------------------

### Discovery flow: list apps, get app, list actions, get action, manage connections

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/anthropic-claude/README.md

Run these commands to explore the anthropic-claude app's available actions and input schemas at runtime. Includes commands to confirm the app slug, get app metadata, list actions (optionally filtered by type), get full action definitions and input fields, and manage connections.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app anthropic-claude

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions anthropic-claude
npx zapier-sdk list-actions anthropic-claude --action-type write
npx zapier-sdk list-actions anthropic-claude --action-type read
npx zapier-sdk list-actions anthropic-claude --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action anthropic-claude <action-type> <action-key>
npx zapier-sdk list-action-input-fields anthropic-claude <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections anthropic-claude
npx zapier-sdk create-connection anthropic-claude   # human completes OAuth
```

--------------------------------

### Run Zoom actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/zoom/README.md

Examples of executing write and search actions for Zoom meetings using the CLI.

```bash
# Create a new Zoom meeting for a scheduled event.
npx zapier-sdk run-action zoom write create_meeting --connection <connection-id> \
  --inputs '{"type":"scheduled"}'

# Search for a Zoom meeting or webinar by type and topic.
npx zapier-sdk run-action zoom search find_meeting --connection <connection-id> \
  --inputs '{"type":"scheduled","topic":"Quarterly Planning","isExactMatch":false}'
```

--------------------------------

### Run SystemeIo actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/systemeio/README.md

Examples of executing write and read actions using the Zapier SDK CLI.

```bash
# Grant a contact access to a specific course.
npx zapier-sdk run-action systemeio write grantAccessToCourse --connection <connection-id> \
  --inputs '{"access_type":"full"}'

# Trigger when a new sale occurs in your system.
npx zapier-sdk run-action systemeio read new_sale_trigger --connection <connection-id> \
  --inputs '{}'
```

--------------------------------

### Install subagent to project directory

Source: https://github.com/zapier/sdk/blob/main/agents/README.md

Use these commands to create the .claude/agents directory and download the zapier-sdk-explorer.md subagent file into your project.

```bash
mkdir -p .claude/agents
curl -o .claude/agents/zapier-sdk-explorer.md \
  https://raw.githubusercontent.com/zapier/sdk/main/agents/zapier-sdk-explorer.md
```

--------------------------------

### Run Google Tasks actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/google-tasks/README.md

Examples for creating a new task and searching for an existing task using the Zapier SDK CLI.

```bash
# Create a new task in a Google Tasks list.
npx zapier-sdk run-action google-tasks write task --connection <connection-id> \
  --inputs '{"title":"Book flights for conference","notes":"Compare prices on Delta and United","due":"2024-06-15T17:00:00Z"}'

# Find a task by its title in Google Tasks.
npx zapier-sdk run-action google-tasks search find_task --connection <connection-id> \
  --inputs '{"title":"Book flights for conference"}'
```

--------------------------------

### Execute HoneyBook write actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/honeybook/README.md

Examples of running write actions to create projects or contacts using the Zapier SDK CLI.

```bash
# Create a new project with client details and event information.
npx zapier-sdk run-action honeybook write create_project --connection <connection-id> \
  --inputs '{"full_name":"Jessica Smith","email":"jessica.smith@example.com","phone_number":"555-1234","event_type":"Wedding","event_date":"2024-09-14","event_details":"Outdoor ceremony at Central Park","event_location":"Central Park, NYC"}'

# Add a new client with contact information.
npx zapier-sdk run-action honeybook write new_contact --connection <connection-id> \
  --inputs '{"full_name":"Michael Johnson","email":"michael.johnson@example.com","address":"456 Oak Street, Springfield","phone_number":"555-5678"}'
```

--------------------------------

### Run Trello actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/trello/README.md

Examples of running write and search actions using the Zapier SDK CLI.

```bash
# Create a comment on a Trello card.
npx zapier-sdk run-action trello write comment --connection <connection-id> \
  --inputs '{"text":"Reviewed the Q2 roadmap and approved changes."}'

# Find a card using a custom search query.
npx zapier-sdk run-action trello search organization_card_custom_query --connection <connection-id> \
  --inputs '{"query":"label:Urgent list:'To Do' due:week","cards_limit":50}'
```

--------------------------------

### Run WordPress Actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/wordpress/README.md

Examples of executing write and search actions using the Zapier SDK CLI with specific input payloads.

```bash
# Upload an image with a caption to the WordPress media library.
npx zapier-sdk run-action wordpress write media --connection <connection-id> \
  --inputs '{"file":"https://images.unsplash.com/photo-1506744038136-46273834b3fb?auto=format&fit=crop&w=800&q=80","filename":"mountain-view.jpg","title":"Mountain View","caption":"A breathtaking view from the top of the mountain.","description":"Photo taken during a hiking trip in the Alps.","alt_text":"Mountain landscape with clouds","comment_status":"open","ping_status":"open"}'

# Find a post by its title.
npx zapier-sdk run-action wordpress search post --connection <connection-id> \
  --inputs '{"title":"How to Start a WordPress Blog"}'
```

--------------------------------

### Run Kajabi actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/kajabi/README.md

Examples of using the CLI to activate or deactivate offers for a user by providing the connection ID and required input JSON.

```bash
# Grant access to an offer for a user.
npx zapier-sdk run-action kajabi write activate_offer --connection <connection-id> \
  --inputs '{"name":"Email Marketing Bootcamp","email":"jane.doe@example.com","external_user_id":"user_12345","send_offer_grant_email":true}'

# Revoke access to an offer for a user.
npx zapier-sdk run-action kajabi write deactivate_offer --connection <connection-id> \
  --inputs '{"external_user_id":"user_12345"}'
```

--------------------------------

### Execute Webflow actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/webflow/README.md

Examples of running write and search actions using the Zapier SDK CLI with specific input parameters.

```bash
# Mark an order as fulfilled and optionally send a fulfillment email.
npx zapier-sdk run-action webflow write fulfill_order --connection <connection-id> \
  --inputs '{"order_id":"ORD-102938","sendOrderFulfilledEmail":true}'

# Find an item by its name or slug.
npx zapier-sdk run-action webflow search find_item --connection <connection-id> \
  --inputs '{"name":"Spring Collection T-Shirt","slug":"spring-collection-tshirt"}'
```

--------------------------------

### Run GitHub actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/github/README.md

Examples of executing write and search actions using the Zapier SDK CLI with specific input payloads.

```bash
# Create a new issue in a GitHub repository.
npx zapier-sdk run-action github write issue --connection <connection-id> \
  --inputs '{"title":"Fix authentication bug","body":"Users are unable to log in with Google accounts since the last release. Please investigate and resolve."}'

# Retrieve the contents of a file from a GitHub repository.
npx zapier-sdk run-action github search get_file_contents --connection <connection-id> \
  --inputs '{"path":"src/components/LoginForm.tsx"}'
```

--------------------------------

### Run Strava actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/strava/README.md

Examples of executing write and search actions for Strava activities using the CLI.

```bash
# Create a new activity in Strava with a name, type, start time, and duration.
npx zapier-sdk run-action strava write create_activity --connection <connection-id> \
  --inputs '{"activity_name":"Morning Ride","activity_type":"Ride","start_date_local":"2024-06-01T06:30:00","activity_elapsed_time":"3600","activity_description":"Fast-paced ride through Central Park."}'

# Find an activity by name or ID in Strava.
npx zapier-sdk run-action strava search find_activity --connection <connection-id> \
  --inputs '{"activity_name":"Morning Ride"}'
```

--------------------------------

### Run Thinkific actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/thinkific/README.md

Examples of executing write and search actions using the Zapier SDK CLI with provided input JSON.

```bash
# Enroll a user in a Thinkific course.
npx zapier-sdk run-action thinkific write enroll_user --connection <connection-id> \
  --inputs '{"first_name":"Jane","last_name":"Doe","email":"jane.doe@example.com","expiry_date":"2024-12-31","company":"Acme Corp"}'

# Search for users by email address.
npx zapier-sdk run-action thinkific search users_list --connection <connection-id> \
  --inputs '{"email":"jane.doe@example.com"}'
```

--------------------------------

### Execute Airtable actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/airtable/README.md

Examples of running write and search actions using the Zapier SDK CLI.

```bash
# Create a new Airtable base in a specific workspace.
npx zapier-sdk run-action airtable write create_base --connection <connection-id> \
  --inputs '{"baseName":"Project Tracker","workspaceId":"wspc12345","tableCount":2}'

# Find a table in Airtable matching a keyword.
npx zapier-sdk run-action airtable search findTable --connection <connection-id> \
  --inputs '{"keyword":"Tasks","searchField":"name"}'
```

--------------------------------

### Run Google Drive actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/google-drive/README.md

Examples of executing file upload and file retrieval actions using the Zapier SDK CLI.

```bash
# Upload a file to Google Drive.
npx zapier-sdk run-action google-drive write file --connection <connection-id> \
  --inputs '{"file":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf","convert":false,"new_name":"Q2 Budget Report.pdf","new_extension":"pdf","idempotency_key":"upload-20240601-01"}'

# Retrieve a file or folder from Google Drive by its ID.
npx zapier-sdk run-action google-drive search file_or_folder_by_id --connection <connection-id> \
  --inputs '{"id":"1a2b3c4d5e6f7g8h9i0j"}'
```

--------------------------------

### get-connection-start-url

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Command to start a connection and get the start URL for message draining. Supports various options for concurrency, lease limits, error handling, and execution modes.

```APIDOC
## get-connection-start-url

### Description
Starts a connection and returns the start URL for message draining. Configure concurrency, lease limits, error handling, and execution modes via options.

### Usage
`zapier-sdk get-connection-start-url [options]`

### Options
- `--concurrency <number>` - Per-message handler workers running in parallel. Defaults to `leaseLimit`, or 1 if neither is set.
- `--lease-limit <number>` - Per-lease HTTP batch size. Defaults to `concurrency`, or 1 if neither is set.
- `--lease-seconds <number>` - Lease duration in seconds.
- `--release-on-error` - If true, errors release the message when the drain finishes. If false (default), errors leave it leased until the lease timeout. `ZapierReleaseTriggerMessageSignal` always releases regardless.
- `--continue-on-error` - If false (default, fail-fast), the first handler error rejects and stops the drain. If true, handler errors are observed via `onError` and the drain continues. SDK-level errors (lease / ack / release) reject regardless.
- `--max-drain-interval-seconds <number>` - Maximum seconds between safety drain attempts (default: 300). The watcher subscribes to SSE notifications for near-real-time wake-ups; this interval is the backstop that guarantees forward progress if SSE events are missed or the connection drops undetected.
- `--exec <string>` - Run a binary per message with no shell interpretation. Message JSON is piped to stdin; exit code 0 acks, non-zero records the error per the same rules as a thrown handler. Pass extra argv after `--` (e.g. `--exec ./handler -- --verbose`). Mutually exclusive with --exec-shell and --json.
- `--exec-shell <string>` - Run a shell command per message. Message JSON is piped to the subprocess on stdin; exit code 0 acks, non-zero records the error per the same rules as a thrown handler. Interpreted by the platform's default shell (sh on POSIX, cmd.exe on Windows). Mutually exclusive with --exec and --json.
- `--json` - Stream each message as JSON to stdout (one record per line, NDJSON), acking as each write completes. Use for piping to other tools. Mutually exclusive with --exec / --exec-shell and the interactive default.
- `-h, --help` - Display help for command.
```

--------------------------------

### init

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Creates a new Zapier SDK project in a new directory with starter files.

```APIDOC
## init

### Description
Creates a new Zapier SDK project in a new directory with starter files.

### Usage
zapier-sdk init [options] <project-name>

### Arguments
- **project-name** (string) - Required - Name of the project directory to create

```

--------------------------------

### init command usage

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Initializes a new Zapier SDK project in a specified directory.

```bash
Usage: zapier-sdk init [options] <project-name>

Create a new Zapier SDK project in a new directory with starter files

Arguments:
  project-name       Name of the project directory to create
```

--------------------------------

### get-connection-start-url command options

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Displays the available options for the get-connection-start-url command.

```bash
Options:
  --allowed-scopes <value>  Scopes to allow for these credentials (default: [])
  --json                    Output raw JSON instead of formatted results
  -h, --help                Display help for command
```

--------------------------------

### Run Zapier Tables log-event example

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/zapier-tables/README.md

Executes the log-event.ts example script using npx and tsx.

```bash
npx tsx examples/by-app/zapier-tables/log-event.ts
```

--------------------------------

### zapier-sdk signup command

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Sets up Zapier account access and SDK credentials. Includes options for non-interactive and headless signup flows.

```bash
Usage: zapier-sdk signup [options]

Set up Zapier account access and SDK credentials

Options:
  --timeout <string>       Signup timeout in seconds (default: 300)
  --use-approvals          Require approvals for actions performed with these
                           credentials
  --non-interactive        Skip interactive prompts. Uses defaults where
                           possible; errors instead of prompting when input is
                           required. Useful in CI, piped output, or
                           environments where TTY detection is unreliable.
  --headless               Use when signing up from a machine that has no
                           browser. Prints a signup link to open elsewhere,
                           then accepts the pasted loopback callback URL.
  --callback-url <string>  Resume a pending non-interactive signup with the
                           final OAuth callback URL from your browser.
  -h, --help               Display help for command
```

--------------------------------

### Install Zapier SDK for Claude Code

Source: https://github.com/zapier/sdk/blob/main/README.md

Commands to add the marketplace and install the Zapier SDK plugin within the Claude Code environment.

```bash
/plugin marketplace add zapier/marketplace
/plugin install sdk@zapier
```

--------------------------------

### Explore ClickUp app and actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/clickup/README.md

Commands to list apps, retrieve metadata, list actions by type, inspect action schemas, and manage connections.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app clickup

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions clickup
npx zapier-sdk list-actions clickup --action-type write
npx zapier-sdk list-actions clickup --action-type read
npx zapier-sdk list-actions clickup --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action clickup <action-type> <action-key>
npx zapier-sdk list-action-input-fields clickup <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections clickup
npx zapier-sdk create-connection clickup   # human completes OAuth
```

--------------------------------

### Idempotency key examples by trigger type

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/workflows.md

Examples of how to define idempotency keys for different trigger types, including webhooks, schedules, and loops.

```typescript
const runId = triggered_at; ctx.step(`aggregate-${runId}`, ...)
```

```typescript
for (const c of contacts) { await ctx.step(`upsert-${c.id}`, ...) }
```

--------------------------------

### Check Zapier SDK and CLI installation status

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/SKILL.md

Use these commands to verify if the SDK library or CLI are installed and to check the current authentication profile.

```bash
# Is the SDK library present?
ls node_modules/@zapier/zapier-sdk 2>/dev/null && echo "SDK installed" || echo "SDK not installed"

# Is the CLI available?
npx zapier-sdk --version 2>/dev/null && echo "CLI installed" || echo "CLI not installed"

# Are you logged in? (returns email + account on success, non-zero exit if not)
npx zapier-sdk get-profile
```

--------------------------------

### Execute create_project write actions

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/dubsado/README.md

Run the create_project action to create a new project for a client, optionally including location details.

```bash
# Create a new project for a client.
npx zapier-sdk run-action dubsado write create_project --connection <connection-id> \
  --inputs '{"projectLocation__name":"Acme Corp HQ","projectLocation__line1":"123 Main St","projectLocation__city":"San Francisco","projectLocation__state":"CA","title":"Brand Refresh for Acme Corp","client__email":"jane.doe@example.com"}'

# Create a new project for a client at a specific location.
npx zapier-sdk run-action dubsado write create_project --connection <connection-id> \
  --inputs '{"projectLocation__name":"WebCo Main Office","projectLocation__line1":"456 Oak Ave","projectLocation__line2":"Suite 200","projectLocation__city":"Los Angeles","projectLocation__state":"CA","title":"Website Redesign","client__email":"john.smith@example.com"}'
```

--------------------------------

### get-table-record

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Gets a single record from a table by ID.

```APIDOC
## get-table-record

### Description
Gets a single record from a table by ID.

### Usage
`zapier-sdk get-table-record [options] [table] [record]`

### Arguments
- `table` - The unique identifier of the table.
- `record` - The ID of the record to retrieve.

### Options
- `--json` - Output raw JSON instead of formatted results.
- `-h, --help` - Display help for command.
```

--------------------------------

### get-connection-start-url command options

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Lists the available options for the get-connection-start-url command, including timeout and polling interval settings.

```bash
Options:
  --timeout-ms <number>        How long to wait before giving up. Default 5
                               minutes (300_000).
  --poll-interval-ms <number>  Delay before the first poll request, in ms.
                               Default 3 seconds (3_000). Subsequent polling
                               cadence is managed by the SDK's polling
                               primitive (backoff with sane defaults).
  --json                       Output raw JSON instead of formatted results
  -h, --help                   Display help for command
```

--------------------------------

### get-table

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Gets detailed information about a specific table.

```APIDOC
## get-table

### Description
Gets detailed information about a specific table.

### Usage
`zapier-sdk get-table [options] [table]`

### Arguments
- `table` - The unique identifier of the table.

### Options
- `--json` - Output raw JSON instead of formatted results.
- `-h, --help` - Display help for command.
```

--------------------------------

### get-trigger-inbox

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Gets details of a trigger inbox by ID.

```APIDOC
## get-trigger-inbox

### Description
Get details of a trigger inbox by ID.

### Usage
`zapier-sdk get-trigger-inbox [options] [inbox]`

### Arguments
- `inbox` - Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint.

### Options
- `--json` - Output raw JSON instead of formatted results
- `-h, --help` - Display help for command

```

--------------------------------

### list-trigger-input-fields

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Get the input fields required for a specific trigger.

```APIDOC
## list-trigger-input-fields

### Description
Get the input fields required for a specific trigger.

### Command
`zapier-sdk list-trigger-input-fields [options] [app] [action]`

### Arguments
- **app** (string) - Required - App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')
- **action** (string) - Required - Action key (e.g., 'send_message' or 'find_row')

### Options
- **--connection** <string> - Optional - Connection alias or connection ID. Required if the trigger needs a connection to determine available fields.
- **--inputs** <object> - Optional - Current input values that may affect the schema (e.g., when fields depend on other field values)
- **--json** - Optional - Output raw JSON instead of formatted results
- **-h, --help** - Optional - Display help for command

```

--------------------------------

### zapier-sdk get-connection

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Gets details for a specific connection by alias or ID.

```APIDOC
## zapier-sdk get-connection

### Description
Get details for a specific connection.

### Usage
`zapier-sdk get-connection [options] [connection]`

### Arguments
- **connection** (string) - Required - Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly.

### Options
- **--json** - Optional - Output raw JSON instead of formatted results
- **-h, --help** - Optional - Display help for command

### Example
```
zapier-sdk get-connection my-alias --json
```
```

--------------------------------

### CLI examples for Monday actions

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/monday/README.md

Run Monday actions via the CLI. The first creates a new board, the second monitors specific columns in a board for changes.

```bash
# Create a new board for project management or tracking.
npx zapier-sdk run-action monday write create_board --connection <connection-id> \
  --inputs '{"board_name":"Marketing Campaign Q3","board_kind":"public"}'
```

```bash
# Monitor specific columns in a board for any changes.
npx zapier-sdk run-action monday read specific_columns_values_changed_in_board --connection <connection-id> \
  --inputs '{"column_ids":"status,date"}'
```

--------------------------------

### Explore Buffer app actions and metadata

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/buffer/README.md

Use these commands to list available actions, retrieve app metadata, and manage connections for the Buffer integration.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app buffer

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions buffer
npx zapier-sdk list-actions buffer --action-type write
npx zapier-sdk list-actions buffer --action-type read
npx zapier-sdk list-actions buffer --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action buffer <action-type> <action-key>
npx zapier-sdk list-action-input-fields buffer <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections buffer
npx zapier-sdk create-connection buffer   # human completes OAuth
```

--------------------------------

### Explore Todoist app metadata and actions via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/todoist/README.md

Commands to list apps, retrieve metadata, list actions by type, and manage connections.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app todoist

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions todoist
npx zapier-sdk list-actions todoist --action-type write
npx zapier-sdk list-actions todoist --action-type read
npx zapier-sdk list-actions todoist --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action todoist <action-type> <action-key>
npx zapier-sdk list-action-input-fields todoist <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections todoist
npx zapier-sdk create-connection todoist   # human completes OAuth
```

--------------------------------

### Discovery flow commands for Cognito Forms app

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/cognito-forms/README.md

Run these commands to explore the Cognito Forms app's available actions and input schemas at runtime. Includes listing apps, getting app metadata, listing actions by type, getting action definitions, and managing connections.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app cognito-forms

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions cognito-forms
npx zapier-sdk list-actions cognito-forms --action-type write
npx zapier-sdk list-actions cognito-forms --action-type read
npx zapier-sdk list-actions cognito-forms --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action cognito-forms <action-type> <action-key>
npx zapier-sdk list-action-input-fields cognito-forms <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections cognito-forms
npx zapier-sdk create-connection cognito-forms   # human completes OAuth
```

--------------------------------

### Discover app actions and metadata

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/tiktok-lead-generation/README.md

Use these commands to explore the app's available actions, metadata, and input schemas.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app tiktok-lead-generation

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions tiktok-lead-generation
npx zapier-sdk list-actions tiktok-lead-generation --action-type write
npx zapier-sdk list-actions tiktok-lead-generation --action-type read
npx zapier-sdk list-actions tiktok-lead-generation --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action tiktok-lead-generation <action-type> <action-key>
npx zapier-sdk list-action-input-fields tiktok-lead-generation <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections tiktok-lead-generation
npx zapier-sdk create-connection tiktok-lead-generation   # human completes OAuth
```

--------------------------------

### list-trigger-input-field-choices

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Get the available choices for a dynamic dropdown input field on a trigger.

```APIDOC
## list-trigger-input-field-choices

### Description
Get the available choices for a dynamic dropdown input field on a trigger.

### Command
`zapier-sdk list-trigger-input-field-choices [options] [app] [action] [input-field]`

### Arguments
- **app** (string) - Required - App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')
- **action** (string) - Required - Action key (e.g., 'send_message' or 'find_row')
- **input-field** (string) - Required - Input field key to get choices for

### Options
- **--connection** <string> - Optional - Connection alias or connection ID. Required if the trigger needs a connection to populate dynamic dropdown options.
- **--inputs** <object> - Optional - Current input values that may affect available choices
- **--page** <number> - Optional - Page number for paginated results
- **--page-size** <number> - Optional - Number of choices per page
- **--max-items** <number> - Optional - Maximum total items to return across all pages
- **--cursor** <string> - Optional - Cursor to start from
- **--json** - Optional - Output raw JSON instead of formatted results
- **-h, --help** - Optional - Display help for command

```

--------------------------------

### npx zapier-sdk get-connection-start-url

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli.md

Gets the OAuth URL directly for agent-driven flows.

```APIDOC
## npx zapier-sdk get-connection-start-url

### Description
Gets the OAuth URL directly, for agent-driven flows.

### Method
CLI command

### Command
npx zapier-sdk get-connection-start-url <app-id>

### Parameters
#### Positional Arguments
- **app-id** (string) - Required - The app identifier (e.g., notion).

### Example
npx zapier-sdk get-connection-start-url notion

### Response
The OAuth start URL.
```

--------------------------------

### Get table details with zapier-sdk get-table

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Retrieve detailed information about a specific table.

```bash
Usage: zapier-sdk get-table [options] [table]

Get detailed information about a specific table

Arguments:
  table       The unique identifier of the table

Options:
  --json      Output raw JSON instead of formatted results
  -h, --help  Display help for command
```

--------------------------------

### Discover JotForm app and action metadata

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/jotform/README.md

Use these commands to explore available actions, app metadata, and input schemas for the JotForm integration.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app jotform

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions jotform
npx zapier-sdk list-actions jotform --action-type write
npx zapier-sdk list-actions jotform --action-type read
npx zapier-sdk list-actions jotform --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action jotform <action-type> <action-key>
npx zapier-sdk list-action-input-fields jotform <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections jotform
npx zapier-sdk create-connection jotform   # human completes OAuth
```

--------------------------------

### Get a single table record with zapier-sdk get-table-record

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Retrieve a single record from a table by its ID.

```bash
Usage: zapier-sdk get-table-record [options] [table] [record]

Get a single record from a table by ID
```

--------------------------------

### get-durable-run

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Gets the full state of a run-once durable run, including its operations journal. This command is experimental.

```APIDOC
## get-durable-run

### Description
Get the full state of a run-once durable run, including its operations journal (experimental)

### Usage
`zapier-sdk get-durable-run [options] [run]`

### Arguments
- `run` - Durable run ID

### Options
- `--json` - Output raw JSON instead of formatted results
- `-h, --help` - Display help for command
```

--------------------------------

### Explore Dropbox actions and schemas via CLI

Source: https://github.com/zapier/sdk/blob/main/examples/by-app/dropbox/README.md

Use these commands to list available apps, metadata, actions, and manage connections for Dropbox.

```bash
# 1. Confirm the app slug
npx zapier-sdk list-apps

# 2. App metadata
npx zapier-sdk get-app dropbox

# 3. List all actions (or filter by type: write | read | search)
npx zapier-sdk list-actions dropbox
npx zapier-sdk list-actions dropbox --action-type write
npx zapier-sdk list-actions dropbox --action-type read
npx zapier-sdk list-actions dropbox --action-type search

# 4. Full definition and input schema for any action
npx zapier-sdk get-action dropbox <action-type> <action-key>
npx zapier-sdk list-action-input-fields dropbox <action-type> <action-key>

# 5. Manage connections
npx zapier-sdk list-connections dropbox
npx zapier-sdk create-connection dropbox   # human completes OAuth
```

--------------------------------

### list-action-input-field-choices

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Gets the available choices for a dynamic dropdown input field. Supports pagination and connection context.

```APIDOC
## list-action-input-field-choices

### Description
Gets the available choices for a dynamic dropdown input field. Supports pagination and connection context.

### Command
`zapier-sdk list-action-input-field-choices [options] [app] [action-type] [action] [input-field]`

### Arguments
- `app` - App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3').
- `action-type` - Action type that matches the action's defined type.
- `action` - Action key (e.g., 'send_message' or 'find_row').
- `input-field` - Input field key to get choices for.

### Options
- `--connection <string>` - Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. Mutually exclusive with connectionId.
- `--inputs <object>` - Current input values that may affect available choices.
- `--page <number>` - Page number for paginated results.
- `--page-size <number>` - Number of choices per page.
- `--max-items <number>` - Maximum total items to return across all pages.
- `--cursor <string>` - Cursor to start from.
- `--json` - Output raw JSON instead of formatted results.
- `-h, --help` - Display help for command.

### Usage Example
```
zapier-sdk list-action-input-field-choices github action send_message channel --connection my-conn --page 1 --page-size 10 --json
```
```

--------------------------------

### Catch Hook Trigger Configuration

Source: https://github.com/zapier/sdk/blob/main/agents/zapier-sdk-explorer.md

Example of how to populate the trigger and params_required_from_scaffold fields specifically for a Catch Hook trigger.

```json
"trigger": {
  "key": "hook_v2",
  "title": "Catch Hook",
  "params": {},
  "source_command": "zapier-sdk --experimental list-triggers WebHookCLIAPI --json"
},
"params_required_from_scaffold": [
  {"key": "_zap_static_hook_code", "generator": "hex(12)", "note": "becomes the path segment of hooks.zapier.com/hooks/catch/<code>/"},
  {"key": "_zap_static_hook_seed", "generator": "hex(12)", "note": "internal seed; opaque"}
]
```

--------------------------------

### get-workflow-version

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Gets full details of a workflow version including source files. Requires the --experimental flag.

```APIDOC
## get-workflow-version

### Description
Gets full details of a workflow version including source files. Requires the --experimental flag.

### Method
CLI command

### Command
zapier-sdk get-workflow-version [options] [workflow] [version]

### Arguments
- **workflow** (string) - Optional - Durable workflow ID
- **version** (string) - Optional - Workflow version ID

### Options
- **--json** (boolean) - Optional - Output raw JSON instead of formatted results
- **-h, --help** (boolean) - Optional - Display help for command

```

--------------------------------

### Get Durable Run Command

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/references/cli-commands.md

Retrieves the full state of a run-once durable run, including its operations journal.

```bash
Usage: zapier-sdk get-durable-run [options] [run]

Get the full state of a run-once durable run, including its operations journal
(experimental)

Arguments:
  run         Durable run ID
```

--------------------------------

### Install subagent globally

Source: https://github.com/zapier/sdk/blob/main/agents/README.md

Use this command to copy the subagent file to your global .claude/agents directory for use across all projects.

```bash
mkdir -p ~/.claude/agents
cp agents/zapier-sdk-explorer.md ~/.claude/agents/
```

--------------------------------

### Create Connection via CLI

Source: https://github.com/zapier/sdk/blob/main/skills/zapier-sdk/SKILL.md

Opens a browser to initiate the OAuth flow for a new connection.

```bash
npx zapier-sdk create-connection notion   # opens a browser, waits for OAuth
```