Zapier SDK

What does this agent do, and when should you use it?

Zapier SDK gives programs access to Zapier's app ecosystem through the npm package @zapier/zapier-sdk, and this repo bundles the SDK's docs, verified examples, and installable agent skills. The execution model is local-first: you authenticate once with npx zapier-sdk login, create an OAuth connection per app with create-connection, then invoke a catalog action with run-action; Zapier stores the credentials and resolves action schemas at runtime, so your code never touches a token. Beyond the SDK and CLI, the repo ships an agentskills.io-conformant zapier-sdk skill, a read-only zapier-sdk-explorer subagent that resolves exact app/action/field IDs, and an examples corpus indexed by app, domain, and pattern. It can be installed as a plugin into Claude Code, OpenAI Codex, and GitHub Copilot CLI, or cloned and referenced from rules files for other assistants. The boundary is clear: your code is portable, but connections and the action catalog live in Zapier.

The repository documents and distributes @zapier/zapier-sdk (runtime) and @zapier/zapier-sdk-cli (companion CLI). The flow: install both packages, run npx zapier-sdk login to store credentials locally, then let createZapierSdk() pick them up automatically. list-connections shows existing grants, create-connection <app> opens a browser to authorize an app such as notion, gmail, google-sheets, or airtable, and run-action <app> <action> --inputs '{...}' executes a catalog action and returns JSON — for example notion search page_by_title, gmail search message, google-sheets search lookup_row, airtable search findRecord. The examples directory is indexed three ways: by-app for single authenticated calls, by-domain READMEs that map a business domain to relevant examples, and by-pattern for end-to-end shapes like notify-on-event, data-sync, lead-routing, and scheduled-report. Every action key in the corpus is checked against listActions before inclusion. skills/zapier-sdk follows the agentskills.io spec, the zapier-sdk-explorer subagent investigates the live catalog before code is written, and sdk.fetch is the escape hatch for arbitrary HTTP APIs.

1. An automation engineer connecting several SaaS tools who does not want to register and refresh OAuth apps per vendor — create connections once, then chain Notion, Gmail, Google Sheets, and Airtable calls.
2. A developer configuring a coding assistant so it validates real action keys with zapier-sdk-explorer before generating SDK code, instead of inventing method names.
3. A sales-ops or growth team doing lead routing: look up an Airtable record with findRecord by email and forward results to the next system.
4. A reporting workflow that pulls rows from Google Sheets via lookup_row or messages from Gmail via search message and summarizes them on a schedule (the scheduled-report pattern).
5. A support or ops person who wants a fast terminal check against an existing connection, e.g. Gmail query-syntax searches for messages from a specific sender.
6. A team building its own agent runtime that loads the agentskills.io-conformant zapier-sdk skill as its tool-calling layer.

How do you install or deploy this agent?

Prerequisites: Node.js and npm (both the SDK and CLI are npm packages) and network access to Zapier.

1) Install the runtime SDK and dev dependencies (README commands as written):

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

2) Optional: install as a plugin for an AI coding assistant (commands reproduced from the README, including its spelling):
Claude Code:

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

OpenAI Codex:

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

GitHub Copilot CLI:

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

3) For assistants without agentskills.io support:

git clone https://github.com/zapier/sdk.git

Then reference skills/zapier-sdk/SKILL.md from .cursorrules, AGENTS.md, or .github/copilot-instructions.md.

4) Authenticate with npx zapier-sdk logincopy; credentials are stored on your machine and reused by createZapierSdk().

How do you use this agent?

Authenticate and check the profile:

npx zapier-sdk login
npx zapier-sdk get-profile

Add app connections (each opens a browser for OAuth):

npx zapier-sdk list-connections
npx zapier-sdk create-connection notion
npx zapier-sdk create-connection gmail
npx zapier-sdk create-connection google-sheets
npx zapier-sdk create-connection airtable

Run actions (JSON output):

npx zapier-sdk run-action notion search page_by_title --inputs '{"title":"Meeting Notes","exact_match":"no"}'
npx zapier-sdk run-action gmail search message --inputs '{"query":"from:[email protected]"}'
npx zapier-sdk run-action google-sheets search lookup_row --inputs '{"spreadsheet":"<sheet-id>","worksheet":"<tab-id>","lookup_key":"Email","lookup_value":"[email protected]"}'
npx zapier-sdk run-action airtable search findRecord --inputs '{"applicationId":"<base-id>","tableName":"Leads","searchByField":"Email","searchByValue":"[email protected]"}'

In code, call createZapierSdk() to reuse stored credentials, and use sdk.fetch for HTTP APIs without a first-class action. Browse examples/by-app/ for single-call patterns, docs.zapier.com/sdk/reference for the full method reference, and skills/zapier-sdk/references/cli-commands.md for the full CLI inventory.

What are this agent's strengths and limitations?

How does this agent compare with similar options?

Key facts side by side with the most closely related agents.

How does FollowAgents rate this agent?

[![FARS review](https://followagents.com/badge/sdk.svg)](https://followagents.com/en/agents/sdk)

<a href="https://followagents.com/en/agents/sdk"><img src="https://followagents.com/badge/sdk.svg" alt="FARS review"></a>

FAQ