> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zapier.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Zapier SDK
> Let your agent connect to anything. Zapier handles the keys.
export const appCountExact = "9,000";
export const appCount = "9,000+";
**The Zapier SDK is now in open beta.** Access is free — try it, break it, and
tell us what to fix. [Give feedback →](https://npsup.zapier.app/contact-us?product=Zapier%20SDK)
Try it with one command →
The SDK gives coding agents and builders programmatic access to Zapier's full app ecosystem. Any API call, on behalf of a user, with no OAuth setup required. Where MCP gives agents a curated menu of pre-built actions, the SDK lets agents go further: write loops, handle edge cases, chain complex logic across apps.
Zapier handles auth, token refresh, retries, and API quirks across {appCount} integrations. Your agent handles the logic.
Agents can write code in seconds. What they can't do is manage OAuth at
scale, handle webhook subscriptions, or enforce enterprise permissions. The
SDK is the interface agents reach for when they need to connect to an app,
take an action, or respond to an event without setting up the auth
infrastructure every time.
Every builder working with agents is either solving the auth problem
themselves — OAuth for each app, token refresh, retries — or going without
it entirely (ungoverned, unaudited). The SDK replaces that with one
integration, backed by the same infrastructure running Zapier's full app
catalog.
## SDK or MCP — Which One Do You Need?
| | MCP | SDK |
| :----------- | :-------------------------------------------------- | :------------------------------------------------------------------------------------------ |
| Best for | Chat agents | Coding agents |
| Access model | Curated menu of pre-built actions | Any API call, in code, authenticated by Zapier |
| Use when | You want a fast, governed set of tools for an agent | You need loops, conditionals, error handling, or calls that go beyond the pre-built catalog |
Most teams end up using both. MCP for conversational agent interfaces; SDK when those agents need to execute code reliably in production.
## What's Available in Open Beta
### In now
* **Full action catalog** — invoke any of {appCount} pre-built actions across Zapier's full app catalog through one programmable interface
* **API call** — raw authenticated HTTP calls to \~3,600 app APIs via Zapier's infrastructure; go beyond pre-built actions to call any supported endpoint directly (more coming soon!)
* **App and action governance** — if your org has restricted specific apps or actions inside Zapier, those policies apply automatically to SDK traffic that uses pre-built actions
* **Free during early access** — no billing changes during the open beta window
### Experimental
* **[Using Triggers](/sdk/using-triggers)** — subscribe to real-time events across connected apps in code; Zapier handles subscription state and webhook reliability.
* **[Permissions](/sdk/permissions)** — review and approve what an agent can do before it acts on your behalf; build reusable allow/deny rules over time.
### Coming soon
* **Self-serve enterprise opt-in/out** — workspace admins toggle SDK access directly, no ticket required
* **Direct API governance** — today, governance applies to pre-built actions only; direct API calls are not yet governable at the policy level. Direct API governance is in progress.
### Not in scope for open beta
* Full raw API call coverage across *all* {appCountExact} apps
**Enterprise and Team plans:** These accounts are off by default. [Contact
us](https://npsup.zapier.app/contact-us?product=Zapier%20SDK) for manual opt-in.
## A Note on Governance
App and action restrictions your org has set up in Zapier apply automatically to SDK pre-built actions — no extra configuration. However, the SDK also provides direct API access via `.fetch()`, which currently falls outside those policy controls.
**Important:** If your agent calls a pre-built action, that action is
governed. If it calls the underlying API endpoint directly via `.fetch()`, it
is not yet governed. Direct API governance is on the roadmap.
## Key Features
* **{appCount} App Integrations**: Access Zapier's entire ecosystem of pre-built connectors
* **Type-Safe**: Full TypeScript support with generated types for every app and action
* **Simple Authentication**: Browser-based signup/login, client credentials, or direct token for seamless auth
* **Paginated Results**: Simple pagination and iteration over lists of resources
* **Built-in Actions**: Easily call our built-in actions with a simple `apps.slack.write.channel_message()` syntax.
* **Custom API Requests**: Use our `fetch` method and make authenticated requests to any API through Zapier's infrastructure to go beyond our built-in actions
## Get Started
**Your agent runs the commands for you**
**Your agent walks you through the process**
Using another IDE agent (Cline, Windsurf, etc.)? Copy this prompt.
```text expandable theme={null}
Set up the Zapier SDK for me. Before installing anything:
- Run `pwd` and tell me the current folder.
- Ask whether to install here or somewhere else.
End with: "Should I set up here, or do you want to point me at a different directory?" Then STOP and wait. If I name a different directory, `cd` there first, creating it with `mkdir -p` if needed. If my reply is ambiguous, use the current directory.
After I confirm the directory, work through these steps one at a time. Run each command in the terminal, report what happened, then continue.
1. Detect the package manager.
Check for pnpm-lock.yaml, yarn.lock, bun.lockb, or package-lock.json. If one exists, use that manager for every install command. If none exist, use npm.
2. Ensure a project exists.
- If package.json exists, use the project as-is and remember this for step 9.
- If package.json is missing, create one: npm init -y
3. Check Node.js is installed at version 20 or higher: node -v
- If Node is missing, tell me to install it from https://nodejs.org or run brew install node, then stop.
- If Node is older than 20, tell me to upgrade it, then stop.
4. Install the SDK: npm install @zapier/zapier-sdk
- An EPERM error on ~/.npm/_cacache usually means the command sandbox is blocking npm cache writes, not that file permissions are broken.
5. Install dev dependencies: npm install -D @zapier/zapier-sdk-cli @types/node typescript tsx
6. Ask whether to install the optional Zapier SDK skill for agent context.
Say: "Do you want me to install the optional Zapier SDK skill for extra agent context? It is not required for SDK setup." Then STOP and wait.
- If I clearly say yes, run: npx skills add zapier/sdk -y
- Otherwise, skip this step and continue.
7. Authenticate with Zapier.
First ask: "Are you signing up or logging in? Am I running on your local machine with a browser, or in a remote/headless environment like Telegram or Discord?" Then STOP and wait. Do not infer the environment.
- If I do not have a Zapier account and we are in a remote environment like Telegram or Discord, run: npx zapier-sdk signup --non-interactive --headless
- If I do not have a Zapier account and you are running on my machine, run: npx zapier-sdk signup --non-interactive
- If I already have a Zapier account and we are in a remote environment like Telegram or Discord, run: npx zapier-sdk login --non-interactive --headless
- If I already have a Zapier account and you are running on my machine, run: npx zapier-sdk login --non-interactive
- If unsure, ask whether to sign up or log in, and whether you are local or remote, before running any auth command.
- Use --headless when auth must happen through a browser outside this terminal. Show me the printed URL and pass the final OAuth callback URL back to the waiting command when I provide it.
- Browser signup/login opens a browser. A permissions or sandbox error usually means credentials could not be written to disk.
- If authentication fails for another reason, try once more.
- After authentication succeeds, confirm the email from the CLI output.
8. List my connected apps: npx zapier-sdk list-connections --owner me --json 2>/dev/null | head -n 1000
- Show only the first 10 results as a markdown table with columns: ID, App Key, Expired. Do not show Title.
- Tell me how many total connections there are. If there are more than 10, say you are only showing the first 10.
- The page size is 100. If exactly 100 connections return, note that more may exist, but do not fetch more pages.
- If the list is empty, tell me to connect at least one app at https://zapier.com/app/assets/connections and come back.
9. If this was an existing project from step 2, scan the codebase and suggest 2-3 concrete ways to integrate the Zapier SDK. Reference real files and patterns you find, for example an API route, tool registry, backend service, or sync script. If this is a fresh project, skip this step.
When setup is done, tell me I am ready and explain:
Zapier has pre-built connectors for 9,000+ apps, including Slack, Google Sheets, Salesforce, GitHub, and thousands more. The SDK and CLI expose that integration layer to code, so you do not have to build OAuth, token refresh, retries, or each app API yourself. My existing Zapier connections are authenticated and ready to use.
- **TypeScript SDK:** for production integrations, backend services, scheduled workflows, and agent tools. It is type-safe, handles token refresh and retries, and uses the same app keys, action keys, and input shapes discovered through the CLI. SDK reference: https://docs.zapier.com/sdk/reference
- **CLI:** for exploration and ad-hoc actions. Use it to inspect apps, fields, and actions, then run one-offs from a terminal or agent. CLI reference: https://docs.zapier.com/sdk/cli-reference
**Want to run a quick test?**
If I have a Slack connection, offer to send me a DM on Slack using the SDK. Describe what will happen and end with: "Want to run this quick test?" Then STOP and wait. Do not output anything else. If I do not have a Slack connection, skip the test.
Only proceed with the test if my reply is clearly affirmative, such as "yes" or "go ahead". If ambiguous, skip the test and continue.
When I say yes, create src/zapier-slack-test.ts with code that:
1. Looks up my Slack user by email using sdk.runAction("slack", "search", "user_by_email", { connectionId: ID, inputs: { email: "ZAPIER_EMAIL" } }).
2. Sends a DM to myself using sdk.runAction("slack", "write", "direct_message", { connectionId: ID, inputs: { channel: "USERNAME", text: "Hello via Zapier SDK" } }).
Replace ID, ZAPIER_EMAIL, and USERNAME with real values from earlier steps. Run it with npx tsx src/zapier-slack-test.ts. If user_by_email fails, ask for my Slack email and try again.
After the test completes, is skipped, or there is no Slack connection:
- Pick 1-3 apps from the connections table and show commands I can use to explore their actions, such as: npx zapier-sdk list-actions APP_KEY
- Do not run those commands.
- Suggest 3 specific ideas based on my connected apps. Each idea should read from one app, optionally process data, and write to another. Do not suggest event-driven workflows. Keep each idea to one sentence. Example: "pull in-progress Jira issues and DM yourself a summary on Slack".
```
Or [follow the manual quickstart guide](/sdk/quickstart#prerequisites) to set up step by step.
### What Can You Build?
### Example Use Case: Reschedule a meeting and notify attendees
Your user says: *"Move my 2pm meeting to Thursday and let the attendees know."*
Your agent finds the meeting in Google Calendar, reschedules it, and messages each attendee in Slack - all via the SDK:
```typescript theme={null}
import { createZapierSdk } from "@zapier/zapier-sdk";
const zapier = createZapierSdk();
// Bind the user's connected accounts
const { data: calConnection } = await zapier.findFirstConnection({
appKey: "google-calendar",
owner: "me",
isExpired: false,
});
const { data: slackConnection } = await zapier.findFirstConnection({
appKey: "slack",
owner: "me",
isExpired: false,
});
const calendar = zapier.apps.google_calendar({
connectionId: calConnection.id,
});
const slack = zapier.apps.slack({ connectionId: slackConnection.id });
// Find a specific meeting
const { data: events } = await calendar.search.event_v2({
inputs: {
calendarid: "Calendar ID",
search_term: "Meeting Title",
},
});
const meeting = events[0] as {
id: string;
summary: string;
attendees: { email: string }[];
};
// Move it to Thursday
await calendar.write.update_event({
inputs: {
calendarid: "Calendar ID",
eventid: meeting.id,
start__dateTime: "2026-02-19T12:00:00-00:00",
end__dateTime: "2026-02-19T12:30:00-00:00",
},
});
// Look up Slack user IDs for all attendees
const slackUsers = await Promise.all(
meeting.attendees.map((attendee) =>
slack.search.user_by_email({ inputs: { email: attendee.email } }),
),
);
// Notify each attendee via Slack DM
for (const { data } of slackUsers) {
const user = data[0] as { id: string };
await slack.write.direct_message({
inputs: {
channel: user.id,
text: `Our "${meeting.summary}" meeting has been moved to Thursday at 12pm.`,
},
});
}
```
## **What's happening under the hood:**
* **`findFirstConnection`** retrieves the user's connected Google Calendar and Slack accounts — no OAuth flows to build
* **`apps.google_calendar(...)`** binds your connect once, so every subsequent call uses those credentials
* **`search`**, **`write`**, and **`read`** map to the type of action: find data, create/update data, or list data
* The SDK handles token refresh, retries, and API differences across apps — your agent just calls actions
## Feedback
**Going beyond local development?** You'll need [client credentials](/sdk/deploy)
to run the SDK on a server, in CI, or on a cloud platform.
**We want your feedback.** The SDK is still taking shape and your input drives
what we build next. Hit a bug? Missing a feature? Have an idea? [Tell us about
it](https://npsup.zapier.app/contact-us?product=Zapier%20SDK)