Quickstart - Zapier

Set up with your AI

Your agent runs the commands for you

https://mintcdn.com/zapier-82f0e938/rR3XBX59eJV84aG0/images/logos/branded/openai.svg?fit=max&auto=format&n=rR3XBX59eJV84aG0&q=85&s=b8031fcd753c6c37e0528a300f79513d

Open in Codex

https://mintcdn.com/zapier-82f0e938/rR3XBX59eJV84aG0/images/logos/branded/claude.svg?fit=max&auto=format&n=rR3XBX59eJV84aG0&q=85&s=9f0b8f48afbdf67c84f41b94925bdfe4

Open in Claude Code

https://mintcdn.com/zapier-82f0e938/rR3XBX59eJV84aG0/images/logos/branded/cursor.svg?fit=max&auto=format&n=rR3XBX59eJV84aG0&q=85&s=05cb7c79b1b7de2d4e43878e0add7190

Open in Cursor

https://mintcdn.com/zapier-82f0e938/rR3XBX59eJV84aG0/images/logos/branded/vs-code.svg?fit=max&auto=format&n=rR3XBX59eJV84aG0&q=85&s=47b212e58fcf15170d4f581a7b6b8d52

Open in VS Code Copilot

Your agent walks you through the process

Open in ChatGPT

Open in Claude

https://mintcdn.com/zapier-82f0e938/rR3XBX59eJV84aG0/images/logos/branded/perplexity.svg?fit=max&auto=format&n=rR3XBX59eJV84aG0&q=85&s=4aae0451a68506f51f10ef9d8167b818

Open in Perplexity

Using another IDE agent (Cline, Windsurf, etc.)? Copy this prompt.

Set up the Zapier SDK for me. Before installing anything:

- Tell me what folder we're currently in (run `pwd` and report the path).
- Ask me whether to install here or in a different directory.

End with: "Should I set up here, or do you want to point me at a different directory?" Then STOP and wait for my reply. If I name a different directory, `cd` to it (creating it with `mkdir -p` if it doesn't exist) first. If my reply is ambiguous, default to the current directory.

Once I've confirmed the directory, work through these steps one at a time, running each command in the terminal and telling me what happened before moving on:

1. Detect the package manager.
   Check for pnpm-lock.yaml, yarn.lock, bun.lockb, or package-lock.json. If one exists, use that manager instead of npm for every install command below. If none exist, default to npm.

2. Ensure a project exists.
   - If there's already a package.json, this is an existing project — use it as-is. Remember this for step 9.
   - If there's no package.json, create one: npm init -y

3. Check Node.js is installed at version 20 or higher: node -v
   - If Node is not found: 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's cache writes, not a file permissions issue.

5. Install dev dependencies: npm install -D @zapier/zapier-sdk-cli @types/node typescript tsx

6. (Optional) Install the Zapier SDK skill for agent context: npx skills add zapier/sdk -y
   This gives you richer context about the SDK — it is not the SDK itself. If it fails for any reason, skip it and continue.

7. Log in to Zapier: npx zapier-sdk login --skip-prompts
   - The --skip-prompts flag tells the CLI not to ask interactive questions, so login won't stall waiting on you. Always pass it when running login.
   - This opens a browser window. A permissions or sandbox error here typically means the command sandbox is preventing credentials from being written to disk.
   - If login fails for another reason, try again.
   - After login succeeds, confirm: "You are authenticated as <email>."

8. List my connected apps: npx zapier-sdk list-connections --owner me --json 2>/dev/null | head -n 1000
   - Read the output and show only the first 10 results as a markdown table with columns: ID, App Key, Expired. Do not show Title. Always tell me how many total connections there are, and if there are more than 10, note that you are only showing the first 10.
   - The page size is 100. If the output contains exactly 100 connections, there may be additional connections beyond this first page. Just note that and move on — do not fetch additional 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 is an existing project (from step 2): suggest how to integrate the SDK.

   Scan the codebase — look at the source files, framework, and structure. Suggest 2–3 concrete ways to integrate the Zapier SDK into this app (e.g. "add a /api/zapier/connections route to your Express server", "create a Zapier tool in your agent's tool registry", "add a sync script that pulls CRM data into your existing DB layer"). Be specific to what you find — reference actual files and patterns.

   If this is a fresh project, skip this step.

Once all steps are done, tell me I am ready and explain:

Zapier has pre-built connectors for 8,000+ apps — Slack, Google Sheets, Salesforce, GitHub, and thousands more. The Zapier SDK and CLI expose that same integration layer to code. Instead of building OAuth flows, handling token refresh, and reverse-engineering each app's API yourself, you get a single consistent interface that already knows how to talk to all of them. Your users' existing Zapier connections are authenticated and ready to use.

- **TypeScript SDK — build production integrations and agent tools:** the SDK is for shipping. Use it when you need something repeatable, embedded, or in production — a scheduled workflow, a backend service, a tool inside an AI agent. It's type-safe, handles token refresh and retries automatically, and uses the same app keys, action keys, and input shapes you already discovered via the CLI. See the SDK reference: https://docs.zapier.com/sdk/reference
- **CLI — explore, run one-offs, or let an agent act:** the CLI is for exploration and ad-hoc action. Use it to see what an app can do, inspect the exact inputs an action expects, and run actions interactively — whether that's you in a terminal or an agent executing a task on demand. See the 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. Do not output anything else. Do not continue to the next section. Wait for my reply before proceeding.

When I reply to the quick test, only proceed if my response is a clear, unambiguous affirmative (e.g. "yes", "go ahead"). If ambiguous or unclear, skip the test and continue.

If I don't have a Slack connection, skip the test and continue.

---

When I reply yes to the quick test, 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 me for my Slack email and try again.

---

After the test completes (or if I skip it, or if there's no Slack connection):

Pick 1–3 apps from the connections table and show me the commands I could use to explore what actions they support. Do not run these commands — just display them so I can try on my own. For example:
   npx zapier-sdk list-actions APP_KEY

**All set! A few ideas to start building with the Zapier SDK:**

Suggest 3 ideas worth exploring — good starting points based on my connected apps. Each idea reads from one app, optionally processes it, and writes to another. Do not suggest anything event-driven. Keep each idea to one sentence. Examples: "get all your in-progress Jira issues and DM yourself a tidy table on Slack"; "pull every HubSpot deal that closed this week and drop it into a Google Sheet". Make the ideas specific to my connected apps — not generic.

Prerequisites

Node.js 20+ installed
A Zapier account (free tier works)
At least one app connected to your Zapier account

Step 1: Install the SDK

Create a new project (or use an existing one) and install the required packages:

# Create a new project (optional)
mkdir my-zapier-project && cd my-zapier-project
npm init -y && npm pkg set type=module

# Install the SDK and CLI
npm install @zapier/zapier-sdk
npm install -D @zapier/zapier-sdk-cli @types/node typescript

# Initialize TypeScript (if starting fresh)
npx tsc --init

The examples in this guide assume you have "type": "module" in your package.json so that you’re using ES modules with support for top-level await. We do that above with npm pkg set type=module.

Step 2: Install the SDK skill

Install the Zapier SDK skill so your coding agent knows how to use the SDK across every future session:

npx skills add zapier/sdk -y

Works with Claude Code, Cursor, Codex, OpenCode, Windsurf, and 50+ other coding agents.

Step 3: Authenticate

The SDK CLI provides a simple browser-based authentication flow:

npx zapier-sdk login

This opens your browser to authenticate with Zapier. Your token is stored locally, and as long as you have the CLI package installed as a development dependency, the SDK will automatically use it.

Building for production or deploying to a server? Browser-based login only works in your local development environment. For any server-side deployment, client credentials are the recommended approach.

Want approvals on these credentials? Pass --use-approvals to provision the credential with an empty permission policy. Every request will prompt you to approve (or deny) the action until you’ve built the policy up. See Permissions for the full flow.

npx zapier-sdk login --use-approvals

Alternative: Client Credentials

The client credentials guide covers creation, secure storage, and how to use them across platforms.

const zapier = createZapierSdk({
  credentials: {
    clientId: process.env.ZAPIER_CREDENTIALS_CLIENT_ID,
    clientSecret: process.env.ZAPIER_CREDENTIALS_CLIENT_SECRET,
  },
});

Alternative: Direct Token

You can also provide a token directly:

const zapier = createZapierSdk({
  credentials: process.env.ZAPIER_CREDENTIALS,
});

Step 4: Generate Types for Your Apps

The SDK can generate TypeScript types for any app, giving you full autocomplete and type safety:

# Add types for the apps you want to use
npx zapier-sdk add slack google-sheets

# Don't know the app key? Search for it
npx zapier-sdk list-apps --search "google sheets"

Types are generated in your src or lib folder by default. You can customize the output location:

npx zapier-sdk add slack --types-output ./types

Step 5: Initialize the SDK

Create a new file (e.g., index.ts) and initialize the SDK:

import { createZapierSdk } from "@zapier/zapier-sdk";

// Initialize with browser-based auth (from `zapier-sdk login`)
const zapier = createZapierSdk();

Step 6: List Your Connected Apps

Let’s verify everything works by listing available apps:

// List the first page of apps
const { data: apps } = await zapier.listApps();

console.log(
  "Available apps:",
  apps.map((app) => app.title)
);

This returns the first page of results. For large datasets, use .items() to iterate over all results or maxItems to limit the total. See the API Reference for pagination patterns.

Run your script:

npx tsx index.ts

Step 7: Run Your First Action

Now let’s execute an action. First, you’ll need a connection for the app you want to use:

// Get Slack connection

// Option 1: Use listConnections when you need to filter or 
// work with multiple connections.
const { data: allSlackConnections } = await zapier.listConnections({
  appKey: "slack",
  owner: "me",
  isExpired: false,
});

const acmeSlackConnection = allSlackConnections.find(c => c?.title?.toLowerCase().includes("acme"))
if (!acmeSlackConnection) {
  console.log(
    "Slack connection matching filter not found. Connect Slack at https://zapier.com/app/assets/connections"
  );
}

// Option 2: Use findFirstConnection when you just need the first 
// available connection and let any errors bubble up
const { data: firstSlackConnection } = await zapier.findFirstConnection({
  appKey: "slack",
  owner: "me",
});

// List Slack channels using your connection
const { data: channels } = await zapier.runAction({
  appKey: "slack",
  actionType: "read",
  actionKey: "channels",
  connectionId: firstSlackConnection.id,
});

console.log("Your Slack channels:", channels);

Step 8: Use the Proxy Pattern (Optional)

For a cleaner syntax, use the app proxy pattern:

const { data: firstSlackConnection } = await zapier.findFirstConnection({
  appKey: "slack",
  owner: "me",
  isExpired: false,
});

// Create a bound Slack instance
const mySlack = zapier.apps.slack({
  connectionId: firstSlackConnection.id,
});

// Now use it with a clean syntax
const { data: channels } = await mySlack.read.channels({});

console.log("Channels:", channels);

// Or pass auth inline without binding
const { data: users } = await zapier.apps.slack.search.user_by_email({
  inputs: { email: "colleague@company.com" },
  connectionId: firstSlackConnection.id,
});

Step 9: Make Custom API Calls with `fetch` (Optional)

Note on governance: The .fetch() method makes authenticated API calls directly, giving you access to any supported endpoint. Unlike pre-built actions, these direct API calls are not currently subject to your org’s app or action restriction policies. If your org has governance requirements, use pre-built actions where possible. Direct API governance is on the roadmap.

When you need to call an API that doesn’t have a built-in action, use fetch to make authenticated requests through the Zapier SDK:

// Get your Slack connection
const { data: slackConnection } = await zapier.findFirstConnection({
  appKey: "slack",
  owner: "me",
  isExpired: false,
});

if (!slackConnection) {
  console.log(
    "No Slack connection found. Connect Slack at https://zapier.com/app/assets/connections"
  );
  process.exit(1);
}

// Make a custom API call—Zapier injects the user's credentials
const response = await zapier.fetch("https://slack.com/api/users.list", {
  method: "GET",
  connectionId: slackConnection.id,
});

const users = await response.json();

Complete Example

Here’s a full example that sends a Slack message:

import { createZapierSdk } from "@zapier/zapier-sdk";

async function main() {
  const zapier = createZapierSdk();

  // Get Slack connection
  const { data: firstSlackConnection } = await zapier.findFirstConnection({
    appKey: "slack",
    owner: "me",
    isExpired: false,
  });

  // Create bound Slack instance
  const slack = zapier.apps.slack({
    connectionId: firstSlackConnection.id,
  });

  // Get available channels
  const { data: channels } = (await slack.read.channels({})) as {
    data: Array<{ id: string; name: string }>;
  };
  const testChannel = channels.find((c) => c.name === "testing");

  if (!testChannel) {
    throw new Error("Could not find #testing channel");
  }

  // Send a message
  const { data: result } = await slack.write.channel_message({
    inputs: {
      channel: testChannel.id,
      text: "Hello from the Zapier SDK!",
    },
  });

  console.log("Message sent!", result);
}

main().catch(console.error);

Next Steps

API Reference — full documentation of all SDK methods and patterns
CLI Reference — command-line tools including list-apps, add, and view-policy
Browse integrations — apps you can connect
Try the demo use case — the meeting reschedule example on the overview page is a confirmed working end-to-end scenario, good for testing your setup
Hit a problem? — tell us what broke via the feedback form

Documentation Index

​Set up with your AI

Open in Codex

Open in Claude Code

Open in Cursor

Open in VS Code Copilot

Open in ChatGPT

Open in Claude

Open in Perplexity

​Prerequisites

​Step 1: Install the SDK

​Step 2: Install the SDK skill

​Step 3: Authenticate

​Step 4: Generate Types for Your Apps

​Step 5: Initialize the SDK

​Step 6: List Your Connected Apps

​Step 7: Run Your First Action

​Step 8: Use the Proxy Pattern (Optional)

​Step 9: Make Custom API Calls with fetch (Optional)

​Complete Example

​Next Steps

Set up with your AI

Prerequisites

Step 1: Install the SDK

Step 2: Install the SDK skill

Step 3: Authenticate

Step 4: Generate Types for Your Apps

Step 5: Initialize the SDK

Step 6: List Your Connected Apps

Step 7: Run Your First Action

Step 8: Use the Proxy Pattern (Optional)

Step 9: Make Custom API Calls with `fetch` (Optional)

Complete Example

Next Steps