@zapier/zapier-sdk-cli
v0.74.0
Published
Command line interface for Zapier SDK
Downloads
22,237
Readme
@zapier/zapier-sdk-cli
Table of Contents
- Quick Start
- Installation
- Walkthrough
- Global Options
- Available Commands
- Accounts
- Actions
- Apps
- Client Credentials
- Code Workflows (Experimental)
cancel-durable-runcreate-workflowcreate-workflow-draftdelete-workflowdisable-workflowdiscard-workflow-draftenable-workflowget-durable-runget-trigger-runget-workflowget-workflow-draftget-workflow-runget-workflow-versionlist-durable-runslist-workflow-draftslist-workflow-runslist-workflow-versionslist-workflowspublish-workflow-draftpublish-workflow-versionrun-durabletrigger-workflowupdate-workflowupdate-workflow-draft
- Connections
- HTTP Requests
- Human Inputs (Experimental)
- Tables
- Triggers
ack-trigger-inbox-messagescreate-trigger-inboxdelete-trigger-inboxdrain-trigger-inboxensure-trigger-inboxget-trigger-inboxget-trigger-input-fields-schemalease-trigger-inbox-messageslist-trigger-inbox-messageslist-trigger-inboxeslist-trigger-input-field-choiceslist-trigger-input-fieldslist-triggerspause-trigger-inboxrelease-trigger-inbox-messagesresume-trigger-inboxupdate-trigger-inboxwatch-trigger-inbox
- Utilities
Quick Start
For new projects.
Bootstrap a new project with everything you need to start integrating thousands of apps through Zapier:
# Create a new Zapier SDK project (scaffolds files, installs deps, and logs you in).
npx @zapier/zapier-sdk-cli init my-zapier-app
# Or skip the interactive prompts and accept all defaults.
npx @zapier/zapier-sdk-cli init my-zapier-app --non-interactiveInstallation
For existing projects.
Run the guided setup to add undeclared Zapier SDK dependencies, authenticate, and inspect your connected apps:
npx @zapier/zapier-sdk-cli setupIf you already have a project and want to add the CLI as a dependency:
npm install -D @zapier/zapier-sdk-cliWalkthrough
# See all available commands
npx zapier-sdk --help
# Login to Zapier.
npx zapier-sdk login
# Search from thousands of supported apps.
npx zapier-sdk list-apps --search "gmail"
# The output will show you the valid keys next to the app title like this:
# 1. Gmail (GoogleMailV2CLIAPI, gmail)
# Run any action for the app, using one of the app keys.
npx zapier-sdk run-action gmail
# This will ask you for the type of action you want to run.
# `search` or `write` are typically great for testing.
# Note that you usually need a connection to the app to run
# the action. If you don't already have one, you can create a new one at:
# https://zapier.com/app/assets/connections
# List connections for an app.
npx zapier-sdk list-connections gmail
# Or only list the ones you own.
npx zapier-sdk list-connections gmail --owner me
# Or just grab the first one.
npx zapier-sdk find-first-connection gmail --owner me
# Make any API request to an app using your connection.
npx zapier-sdk fetch "https://gmail.googleapis.com/gmail/v1/users/me/labels" --connection-id 123Global Options
These options are available for all commands:
| Option | Short | Description |
| --------------------------------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --version | -V | Display version number |
| --help | -h | Display help for command |
| --credentials <token> | | Authentication token. |
| --credentials-client-id <id> | | OAuth client ID for authentication. |
| --credentials-client-secret <secret> | | OAuth client secret for authentication. |
| --credentials-base-url <url> | | Override authentication base URL. |
| --debug | | Enable debug logging. |
| --base-url <url> | | Base URL for Zapier API endpoints. |
| --tracking-base-url <url> | | Base URL for Zapier tracking endpoints. |
| --max-network-retries <count> | | Max retries for rate-limited requests (default: 3). |
| --max-network-retry-delay-seconds <seconds> | | Max delay in seconds to wait for a rate-limit retry (default: 60). |
| --max-concurrent-requests <count> | | Max concurrent in-flight HTTP requests (default: 200, max: 10000). |
| --approval-timeout-seconds <seconds> | | Timeout in seconds for approval polling. Default: 600 (10 min). |
| --max-approval-retries | | Maximum number of sequential approval rounds per request (one per gating policy) before giving up. Default: 2. |
| --approval-mode | | Approval flow behavior for manual approvals. "poll" creates the approval, opens it in a browser, polls until resolved, and retries the original request. "throw" creates the manual approval and throws a ZapierApprovalError with the approval URL so the caller can surface it. Server-created auto-mode approvals always poll until they reach a terminal status and retry the original request on approval, even when this option is "throw". "disabled" throws a ZapierApprovalError on approval-required responses without creating an approval. Resolution order is: explicit option, then ZAPIER_APPROVAL_MODE, then the default behavior (poll for interactive TTY, throw otherwise). |
| --open-auto-mode-approvals-in-browser | | By default, auto-mode approvals do not open in a browser. Enable this option to open the approval URL and watch the approval process. Resolution order is: explicit option, then ZAPIER_OPEN_AUTO_MODE_APPROVALS_IN_BROWSER, then false. |
| --can-include-shared-connections | | Allow listing shared connections. |
| --can-include-shared-tables | | Allow listing shared tables. |
| --can-delete-tables | | Allow deleting tables. |
| --json | | Output raw JSON instead of formatted results |
Available Commands
The CLI automatically generates commands from the SDK registry. All SDK functions are available as CLI commands using kebab-case naming.
Boolean flags are presence toggles and take no value: pass --flag to enable it, or omit the flag to use the default. Flags where disabling differs from omitting document a separate disable flag (e.g. --disabled). A value after a boolean flag (--flag false) is rejected as an extra argument.
Accounts
get-profile
Get current user's profile information
Usage:
npx zapier-sdk get-profilelogin
Log in to Zapier to access your account
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------------- | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| --name | string | ❌ | — | — | Name to identify these credentials (defaults to @). Provide this to set a custom name without the interactive prompt. |
| --timeout | string | ❌ | — | — | Login timeout in seconds (default: 300) |
| --use-approvals | boolean | ❌ | — | — | Require approvals for actions performed with these credentials |
| --non-interactive | boolean | ❌ | — | — | 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 | boolean | ❌ | — | — | Use when logging in from a machine that has no browser. Prints a login link to open elsewhere, then accepts the pasted loopback callback URL. |
| --callback-url | string | ❌ | — | — | Resume a pending non-interactive login with the final OAuth callback URL from your browser. |
Usage:
npx zapier-sdk login [--name] [--timeout] [--use-approvals] [--non-interactive] [--headless] [--callback-url]logout
Log out of your Zapier account
Usage:
npx zapier-sdk logoutsignup
Set up Zapier account access and SDK credentials
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------------- | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| --timeout | string | ❌ | — | — | Signup timeout in seconds (default: 300) |
| --use-approvals | boolean | ❌ | — | — | Require approvals for actions performed with these credentials |
| --non-interactive | boolean | ❌ | — | — | 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 | boolean | ❌ | — | — | 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. |
Usage:
npx zapier-sdk signup [--timeout] [--use-approvals] [--non-interactive] [--headless] [--callback-url]Actions
create-action-run
Start an action run and return its ID without waiting for the result. Running an action is asynchronous: this hands back a run ID immediately, and getActionRun fetches the outcome. Reach for this pair when you want to start work and collect it later (fan out many runs, hand the ID to another process, survive a restart). runAction is the one-call form that starts a run and waits for its result.
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <app> | string | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., '[email protected]') |
| <action-type> | string | ✅ | — | read, read_bulk, write, run, search, search_or_write, search_and_write, filter | Action type that matches the action's defined type |
| <action> | string | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
| --connection | string, number | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Required if the action needs a connection to authenticate and interact with the service. Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
| --inputs | object | ❌ | — | — | Input parameters for the action |
| --page | string | ❌ | — | — | Page to fetch for bulk read actions. Pass the next_page a previous run returned to fetch the following page. |
| --callback-url | string | ❌ | — | — | URL Zapier posts the finished run to, so you do not have to poll for it. Must use HTTPS and resolve to a public host, so a local receiver needs a tunnel. The body matches what getActionRun returns. Verify the Zapier-Callback-Signature header, and expect the same run to arrive more than once. |
Usage:
npx zapier-sdk create-action-run <app> <action-type> <action> [--connection] [--inputs] [--page] [--callback-url]get-action
Get detailed information about a specific action
Options:
| Option | Type | Required | Default | Possible Values | Description |
| --------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| <app> | string | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., '[email protected]') |
| <action-type> | string | ✅ | — | read, read_bulk, write, run, search, search_or_write, search_and_write, filter | Action type that matches the action's defined type |
| <action> | string | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
Usage:
npx zapier-sdk get-action <app> <action-type> <action>get-action-input-fields-schema
Get the JSON Schema representation of input fields for an action. Returns a JSON Schema object describing the structure, types, and validation rules for the action's input parameters.
Options:
| Option | Type | Required | Default | Possible Values | Description |
| --------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <app> | string | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
| <action-type> | string | ✅ | — | read, read_bulk, write, run, search, search_or_write, search_and_write, filter | Action type that matches the action's defined type |
| <action> | string | ✅ | — | — | Action key to get the input schema for |
| --connection | string, number | ❌ | — | — | 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 the schema (e.g., when fields depend on other field values) |
Usage:
npx zapier-sdk get-action-input-fields-schema <app> <action-type> <action> [--connection] [--inputs]get-action-run
Fetch the current state of an action run started by createActionRun. This is a point-in-time read that returns immediately: a run Zapier has not finished executing comes back with status waiting, so call again to check for a result. runAction starts a run and waits for its result in one call. Results are stored for seven days after the run was created.
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------- | -------- | -------- | ------- | --------------- | ------------------------------------------- |
| <run> | string | ✅ | — | — | Action run ID returned by createActionRun |
Usage:
npx zapier-sdk get-action-run <run>list-action-input-field-choices
Get the available choices for a dynamic dropdown input field
Options:
| Option | Type | Required | Default | Possible Values | Description |
| --------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <app> | string | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., '[email protected]') |
| <action-type> | string | ✅ | — | read, read_bulk, write, run, search, search_or_write, search_and_write, filter | Action type that matches the action's defined type |
| <action> | string | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
| <input-field> | string | ✅ | — | — | Input field key to get choices for |
| --connection | string, number | ❌ | — | — | 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 |
Usage:
npx zapier-sdk list-action-input-field-choices <app> <action-type> <action> <input-field> [--connection] [--inputs] [--page] [--page-size] [--max-items] [--cursor]list-action-input-fields
Get the input fields required for a specific action
Options:
| Option | Type | Required | Default | Possible Values | Description |
| --------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <app> | string | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., '[email protected]') |
| <action-type> | string | ✅ | — | read, read_bulk, write, run, search, search_or_write, search_and_write, filter | Action type that matches the action's defined type |
| <action> | string | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
| --connection | string, number | ❌ | — | — | 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 fields |
| --page-size | number | ❌ | — | — | Number of input fields per page |
| --max-items | number | ❌ | — | — | Maximum total items to return across all pages |
| --cursor | string | ❌ | — | — | Cursor to start from |
Usage:
npx zapier-sdk list-action-input-fields <app> <action-type> <action> [--connection] [--inputs] [--page-size] [--max-items] [--cursor]list-actions
List all actions for a specific app
Options:
| Option | Type | Required | Default | Possible Values | Description |
| --------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| <app> | string | ✅ | — | — | App key of actions to list (e.g., 'SlackCLIAPI' or slug like 'github') |
| --action-type | string | ❌ | — | read, read_bulk, write, run, search, search_or_write, search_and_write, filter | Filter actions by type |
| --page-size | number | ❌ | — | — | Number of actions per page |
| --max-items | number | ❌ | — | — | Maximum total items to return across all pages |
| --cursor | string | ❌ | — | — | Cursor to start from |
Usage:
npx zapier-sdk list-actions <app> [--action-type] [--page-size] [--max-items] [--cursor]run-action
Execute an action with the given inputs
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <app> | string | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., '[email protected]') |
| <action-type> | string | ✅ | — | read, read_bulk, write, run, search, search_or_write, search_and_write, filter | Action type that matches the action's defined type |
| <action> | string | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
| --connection | string, number | ❌ | — | — | 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 | ❌ | — | — | Input parameters for the action |
| --timeout-seconds | number | ❌ | — | — | Maximum time to wait for action completion in seconds (default: 180) |
| --page-size | number | ❌ | — | — | Number of results per page |
| --max-items | number | ❌ | — | — | Maximum total items to return across all pages |
| --cursor | string | ❌ | — | — | Cursor to start from |
Usage:
npx zapier-sdk run-action <app> <action-type> <action> [--connection] [--inputs] [--timeout-seconds] [--page-size] [--max-items] [--cursor]Apps
get-app
Get detailed information about a specific app
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
| <app> | string | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., '[email protected]') |
Usage:
npx zapier-sdk get-app <app>list-apps
List all available apps with optional filtering
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
| --search | string | ❌ | — | — | Search term to filter apps by name |
| --page-size | number | ❌ | — | — | Number of apps per page |
| --apps | array | ❌ | — | — | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
| --max-items | number | ❌ | — | — | Maximum total items to return across all pages |
| --cursor | string | ❌ | — | — | Cursor to start from |
Usage:
npx zapier-sdk list-apps [--search] [--page-size] [--apps] [--max-items] [--cursor]Client Credentials
create-client-credentials
Create new client credentials for the authenticated user
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------------ | -------- | -------- | -------------- | --------------- | ---------------------------------------------- |
| <name> | string | ✅ | — | — | Human-readable name for the client credentials |
| --allowed-scopes | array | ❌ | ["external"] | — | Scopes to allow for these credentials |
Usage:
npx zapier-sdk create-client-credentials <name> [--allowed-scopes]delete-client-credentials
Delete client credentials by client ID
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------- |
| <client-id> | string | ✅ | — | — | The client ID of the client credentials to delete |
Usage:
npx zapier-sdk delete-client-credentials <client-id>list-client-credentials
List client credentials for the authenticated user
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------- |
| --page-size | number | ❌ | — | — | Number of credentials per page |
| --max-items | number | ❌ | — | — | Maximum total items to return across all pages |
| --cursor | string | ❌ | — | — | Cursor to start from |
Usage:
npx zapier-sdk list-client-credentials [--page-size] [--max-items] [--cursor]Code Workflows (Experimental)
ℹ️ Experimental. Run commands via the
zapier-sdk-experimentalbinary, pass--experimentaltozapier-sdk, or setZAPIER_EXPERIMENTAL=truein the environment. Flags and behavior may change between versions.
cancel-durable-run 🧪 experimental
Cancel a run-once durable run in initialized or started status. Returns 409 if the run is already terminal.
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------- | -------- | -------- | ------- | --------------- | -------------- |
| <run> | string | ✅ | — | — | Durable run ID |
Usage:
npx zapier-sdk cancel-durable-run <run>create-workflow 🧪 experimental
Create a durable workflow container. Starts disabled with no version; publish a version to add code.
Options:
| Option | Type | Required | Default | Possible Values | Description |
| --------------- | --------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------- |
| <name> | string | ✅ | — | — | Workflow name |
| --description | string | ❌ | — | — | Optional description for the workflow |
| --private | boolean | ❌ | — | — | If true, only the creating user can see or manage this workflow. Defaults to false (account-visible). |
Usage:
npx zapier-sdk create-workflow <name> [--description] [--private]create-workflow-draft 🧪 experimental
Fork a new draft from the workflow's current live version (or a blank stub before the first publish)
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------ | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------- |
| <workflow> | string | ✅ | — | — | Durable workflow ID |
| --slug | string | ❌ | — | — | Optional slug for URL routing. When omitted, the server generates one. |
Usage:
npx zapier-sdk create-workflow-draft <workflow> [--slug]delete-workflow 🧪 experimental
Delete a durable workflow. Throws ZapierNotFoundError if the workflow doesn't exist; callers wanting idempotency should catch that themselves.
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------ | -------- | -------- | ------- | --------------- | ------------------- |
| <workflow> | string | ✅ | — | — | Durable workflow ID |
Usage:
npx zapier-sdk delete-workflow <workflow>disable-workflow 🧪 experimental
Disable a durable workflow so it stops accepting triggers
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------ | -------- | -------- | ------- | --------------- | ------------------- |
| <workflow> | string | ✅ | — | — | Durable workflow ID |
Usage:
npx zapier-sdk disable-workflow <workflow>discard-workflow-draft 🧪 experimental
Discard an open workflow draft (soft delete). The draft's unpublished edits stop resolving; the published version is untouched.
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------ | -------- | -------- | ------- | --------------- | ------------------- |
| <workflow> | string | ✅ | — | — | Durable workflow ID |
| <draft> | string | ✅ | — | — | Workflow draft ID |
Usage:
npx zapier-sdk discard-workflow-draft <workflow> <draft>enable-workflow 🧪 experimental
Enable a durable workflow so it accepts triggers
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------ | -------- | -------- | ------- | --------------- | ------------------- |
| <workflow> | string | ✅ | — | — | Durable workflow ID |
Usage:
npx zapier-sdk enable-workflow <workflow>get-durable-run 🧪 experimental
Get the full state of a run-once durable run, including its operations journal
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------- | -------- | -------- | ------- | --------------- | -------------- |
| <run> | string | ✅ | — | — | Durable run ID |
Usage:
npx zapier-sdk get-durable-run <run>get-trigger-run 🧪 experimental
Get the workflow run associated with a deployed workflow's trigger. Useful immediately after firing a trigger, when you have the trigger ID but not yet the run ID.
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ----------- | -------- | -------- | ------- | --------------- | ------------------- |
| <trigger> | string | ✅ | — | — | Workflow trigger ID |
Usage:
npx zapier-sdk get-trigger-run <trigger>get-workflow 🧪 experimental
Get a durable workflow with its current version details and trigger claim status
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------ | -------- | -------- | ------- | --------------- | ------------------- |
| <workflow> | string | ✅ | — | — | Durable workflow ID |
Usage:
npx zapier-sdk get-workflow <workflow>get-workflow-draft 🧪 experimental
Get full details of a workflow draft including source files
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------ | -------- | -------- | ------- | --------------- | ------------------- |
| <workflow> | string | ✅ | — | — | Durable workflow ID |
| <draft> | string | ✅ | — | — | Workflow draft ID |
Usage:
npx zapier-sdk get-workflow-draft <workflow> <draft>get-workflow-run 🧪 experimental
Get the current state of a workflow run (a triggered execution of a deployed workflow)
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------ | -------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------- |
| <run> | string | ✅ | — | — | Workflow run ID |
| --workflow | string | ❌ | — | — | Parent workflow ID — used only to scope the CLI run-id picker; ignored by the API call. |
Usage:
npx zapier-sdk get-workflow-run <run> [--workflow]get-workflow-version 🧪 experimental
Get full details of a workflow version including source files
Options:
| Option | Type | Required | Default | Possible Values | Description |
| ------------ | -------- | -------- | ------- | --------------- | ------------------- |
| <workflow> | string | ✅ | — | — | Durable workflow ID |
| <version> | string | ✅ | — | — | Workflow version ID |
Usage:
npx zapier-sdk get-workflow-version <workflow> <version>list-durable-runs 🧪 experimental
List run-once durable runs for the authenticated account, newest first
