Skip to content
Back to search

sdk

Agent skills for writing Zapier SDK code that works.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/zapier-sdk/badge.svg)](/listings/zapier-sdk)

HTML

<a href="/listings/zapier-sdk"><img src="/api/listings/zapier-sdk/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Prefer to let your AI coding assistant handle setup? [Install as a plugin instead](#install-with-your-favorite-ai-coding-assistant).

1. Install

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

2. Authenticate

Log in once. Your credentials get stored on your machine and picked up automatically the next time you call `createZapierSdk()`.

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

3. Connect an app

Every action needs a *connection*: an OAuth grant Zapier holds for the app you're calling. Add one (or several) for whichever apps you want to try. Each `create-connection` command 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

Any of Zapier's 9,000+ apps works. Swap `notion` for the slug you need.

4. Fire an action

Once you have a connection, `run-action` calls any action from the CLI.

# Search Notion pages by title
npx zapier-sdk run-action notion search page_by_title \
  --inputs '{"title":"Meeting Notes","exact_match":"no"}'

# Search Gmail with the standard Gmail query syntax
npx zapier-sdk run-action gmail search message \
  --inputs '{"query":"from:receipts@stripe.com"}'

# Look up a Google Sheets row by column value
npx zapier-sdk run-action google-sheets search lookup_row \
  --inputs '{"spreadsheet":"<sheet-id>","worksheet":"<tab-id>","lookup_key":"Email","lookup_value":"jane@example.com"}'

# Find an Airtable record by field
npx zapier-sdk run-action airtable search findRecord \
  --inputs '{"applicationId":"<base-id>","tableName":"Leads","searchByField":"Email","searchByValue":"jane@example.com"}'

Full API reference at [docs.zapier.com/sdk/reference](https://docs.zapier.com/sdk/reference).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/plugin.json · Manifest · 23 lines
  1. {
  2. "name": "sdk",
  3. "description": "Agent skills for writing Zapier SDK code that works.",
  4. "version": "0.1.0",
  5. "author": {
  6. "name": "Zapier",
  7. "email": "support@zapier.com",
  8. "url": "https://zapier.com"
  9. },
  10. "homepage": "https://docs.zapier.com/sdk",
  11. "repository": "https://github.com/zapier/sdk",
  12. "license": "MIT",
  13. "keywords": [
  14. "zapier",
  15. "sdk",
  16. "agent",
  17. "ai-agent",
  18. "mcp",
  19. "automation",
  20. "integration",
  21. "typescript"
  22. ]
  23. }
README.md · README · 142 lines
  1. <div align="center">
  2. <img src="assets/readme/banner.svg" width="100%" alt="Zapier SDK — let your agent connect to anything; Zapier handles the keys. A pixel-art key on a keyring of app-colored charms.">
  3. </div>
  4. Let your agent connect to anything. Zapier handles the keys.
  5. Programmatic access to Zapier's full app ecosystem via [`@zapier/zapier-sdk`](https://www.npmjs.com/package/@zapier/zapier-sdk) on npm. Any API call, on behalf of a user.
  6. This repo bundles the SDK's docs and installable agent skills.
  7. ![Terminal demo: zapier-sdk discovers Notion's search actions from the live catalog, then run-action calls one through an existing OAuth connection and returns matching pages as JSON](assets/readme/demo.svg)
  8. <sub>Captured CLI output, replayed — not a mockup. The copyable commands are in <a href="#getting-started">Getting started</a> below; the capture provenance lives in <a href=".github/scripts/readme-art/transcript.mjs"><code>transcript.mjs</code></a>.</sub>
  9. ## Getting started
  10. Prefer to let your AI coding assistant handle setup? [Install as a plugin instead](#install-with-your-favorite-ai-coding-assistant).
  11. ### 1. Install
  12. ```bash
  13. npm install @zapier/zapier-sdk
  14. npm install -D @zapier/zapier-sdk-cli @types/node typescript
  15. ```
  16. ### 2. Authenticate
  17. Log in once. Your credentials get stored on your machine and picked up automatically the next time you call `createZapierSdk()`.
  18. ```bash
  19. npx zapier-sdk login
  20. npx zapier-sdk get-profile
  21. ```
  22. ### 3. Connect an app
  23. Every action needs a *connection*: an OAuth grant Zapier holds for the app you're calling. Add one (or several) for whichever apps you want to try. Each `create-connection` command opens a browser for OAuth.
  24. ```bash
  25. npx zapier-sdk list-connections
  26. npx zapier-sdk create-connection notion
  27. npx zapier-sdk create-connection gmail
  28. npx zapier-sdk create-connection google-sheets
  29. npx zapier-sdk create-connection airtable
  30. ```
  31. Any of Zapier's 9,000+ apps works. Swap `notion` for the slug you need.
  32. ### 4. Fire an action
  33. Once you have a connection, `run-action` calls any action from the CLI.
  34. ```bash
  35. # Search Notion pages by title
  36. npx zapier-sdk run-action notion search page_by_title \
  37. --inputs '{"title":"Meeting Notes","exact_match":"no"}'
  38. # Search Gmail with the standard Gmail query syntax
  39. npx zapier-sdk run-action gmail search message \
  40. --inputs '{"query":"from:receipts@stripe.com"}'
  41. # Look up a Google Sheets row by column value
  42. npx zapier-sdk run-action google-sheets search lookup_row \
  43. --inputs '{"spreadsheet":"<sheet-id>","worksheet":"<tab-id>","lookup_key":"Email","lookup_value":"jane@example.com"}'
  44. # Find an Airtable record by field
  45. npx zapier-sdk run-action airtable search findRecord \
  46. --inputs '{"applicationId":"<base-id>","tableName":"Leads","searchByField":"Email","searchByValue":"jane@example.com"}'
  47. ```
  48. Full API reference at [docs.zapier.com/sdk/reference](https://docs.zapier.com/sdk/reference).
  49. ## How it fits together
  50. Your code calls one npm package; Zapier holds the OAuth grants and resolves action schemas at runtime, so your code never touches a token.
  51. ![Architecture: your agent, your backend, and the zapier-sdk CLI call @zapier/zapier-sdk; the SDK talks HTTPS to the Zapier platform, which holds the OAuth connections and the live action catalog, with sdk.fetch as the escape hatch for any HTTP API](assets/readme/architecture.svg)
  52. ## Install with your favorite AI coding assistant
  53. Drop every best practice for writing Zapier SDK code straight into your agent's context. Your agent picks up:
  54. - **The `zapier-sdk` skill**: how to authenticate, discover apps and actions at runtime, run actions without inventing method names, and reach for the right escape hatch when there's no first-class action.
  55. - **The `zapier-sdk-explorer` subagent**: a read-only investigator that resolves exact app / action / field IDs against the live Zapier catalog before your agent writes a line of code.
  56. Result: fewer round trips to the docs, no more invented action keys, and workflows that work the first time.
  57. ### Claude Code
  58. ```
  59. /plugin marketplace add zapier/marketplace
  60. /plugin install sdk@zapier
  61. ```
  62. ### OpenAI Codex
  63. ```
  64. codex plugin marketplace add zapier/marketplace
  65. codex plugin add sdk@zapier
  66. ```
  67. Or open the in-CLI picker with `/plugins` and toggle the SDK plugin on.
  68. ### GitHub Copilot CLI
  69. ```
  70. copilot plugin marketplace add zapier/marketplace
  71. copilot plugin install sdk@zapier
  72. ```
  73. ### Cursor and other assistants
  74. The [skill](./skills/zapier-sdk/) conforms to [agentskills.io](https://agentskills.io) so any conformant runtime can load it directly. For tools without native agentskills.io support, clone the repo and reference `skills/zapier-sdk/SKILL.md` from your assistant's rules or instructions file (`.cursorrules`, `AGENTS.md`, `.github/copilot-instructions.md`, etc.):
  75. ```
  76. git clone https://github.com/zapier/sdk.git
  77. ```
  78. ## Learn more
  79. - **[zapier.com/sdk](https://zapier.com/sdk)** — product page, pricing, and what the SDK unlocks.
  80. - **[docs.zapier.com/sdk](https://docs.zapier.com/sdk)** — SDK guides and tutorials.
  81. - **[docs.zapier.com/sdk/reference](https://docs.zapier.com/sdk/reference)** — full method reference.
  82. - **[docs.zapier.com/sdk/cli-reference](https://docs.zapier.com/sdk/cli-reference)** — CLI reference for `zapier-sdk`.
  83. - **[`@zapier/zapier-sdk`](https://www.npmjs.com/package/@zapier/zapier-sdk)** — runtime SDK on npm.
  84. - **[`@zapier/zapier-sdk-cli`](https://www.npmjs.com/package/@zapier/zapier-sdk-cli)** — CLI companion on npm.
  85. - **[Zapier MCP](https://github.com/zapier/zapier-mcp)** — the MCP-server alternative for tool-calling from Cursor, Claude Desktop, or Codex.
  86. - **[`llms.txt`](./llms.txt)** — this repo's LLM-friendly index of the skill and agents.
  87. - **[docs.zapier.com/llms.txt](https://docs.zapier.com/llms.txt)** — LLM-friendly index of the docs.
  88. - **[docs.zapier.com](https://docs.zapier.com)** — everything else Zapier.
  89. ## Contributing
  90. PRs and feature requests welcome. Start with [CONTRIBUTING.md](./CONTRIBUTING.md). For SDK security issues, email **security@zapier.com** — don't open a public issue.
  91. ## Trademarks
  92. Product and company names used in these examples are trademarks of their respective owners and are used only to identify the service each example integrates with. These examples are not affiliated with, endorsed by, or sponsored by those companies.
  93. ## License
  94. MIT (see [LICENSE](./LICENSE)) — covers the code only. Using the Zapier service and APIs through this SDK is governed separately by the [Zapier Terms of Service](https://zapier.com/legal/terms-of-service) or your other agreement with Zapier for use of the Zapier service.

Version history

  • v0.1.011/12/2026

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.