Zapier — docs.zapier.com

Local index for developer documentation — SDK, MCP, integration building, embedding, White Label. Root map: zapier.com/llms.txt

• Documentation home: Building integrations, building with the SDK, MCP, or embedding Zapier.
• Install Zapier: Front-door router. Pick the right surface (MCP, SDK, or CLI) for connecting Zapier to an agent.

---

Install Zapier

The front door for setting up Zapier with an AI agent. Routes to the right surface based on what the person needs. Also installable as a skill via npx @zapier/install-zapier.

Root map: zapier.com/llms.txt#install

• Install router: Pick MCP (AI clients), SDK (code), or CLI (terminal), with steps for each.
• npm package: @zapier/install-zapier
• Source: github.com/zapier/install-zapier

---

Zapier SDK

The TypeScript SDK and CLI for coding agents and developers who need programmatic access to Zapier's 9,000+ app integrations. Zapier handles auth, tokens, and retries.

Root map: zapier.com/llms.txt#sdk

• Zapier SDK overview: Let your agent connect to anything. Zapier handles the keys.
• Quickstart: Get up and running with the Zapier SDK in 5 minutes.
• API Reference: Complete reference for all Zapier SDK methods.
• CLI Reference: Complete reference for all Zapier SDK CLI commands.
• Using the CLI: Walkthrough of common CLI workflows.
• Changelog: Release history for the Zapier TypeScript SDK and CLI.

npm packages: @zapier/zapier-sdk | @zapier/zapier-sdk-cli | @zapier/zapier-sdk-core Source: github.com/zapier/sdk

---

Zapier MCP

Setup and configuration for the Zapier MCP server. Connects MCP-aware clients to Zapier's integration layer.

Root map: zapier.com/llms.txt#mcp

• MCP home: Overview of Zapier MCP and what it enables.
• Quickstart: Get up and running with Zapier MCP in 5 minutes.
• Supported clients: Which MCP clients work with Zapier (Claude, Cursor, VS Code, ChatGPT, etc.) and how to connect them.
• Usage and billing: How Zapier MCP usage works, rate limits, and pricing.
• Chatbot helper: AI chatbot for MCP support questions.
• Community: Join the Zapier MCP community.

npm package: @zapier/zapier-sdk-mcp

---

Integration Builder — Getting Started

For developers publishing apps to the Zapier directory. Start here to understand the platform, then choose Platform UI or Platform CLI.

Root map: zapier.com/llms.txt#developers

• Welcome: Integration Builder documentation home.
• How Zapier works: Conceptual overview of triggers, actions, and Zaps.
• Build your integration: End-to-end guide from start to finish.
• Platform UI tutorial: Build an integration using the visual builder.
• Platform CLI tutorial: Build an integration using the CLI.
• Platform UI vs Platform CLI: Which tool to use and when.
• Zapier integration structure: How integration projects are organized.
• Private vs public integrations: Choosing your integration audience.
• Recommended triggers and actions: What features users value most by app category.
• Glossary: Zapier-specific terms defined.
• Get help: Support channels for integration builders.
• App Developer Services: Solution Partners who can build integrations for you.
• Integration platform login: Access the developer platform.

---

Integration Builder — Building with Platform CLI

Guides for building integrations using zapier-platform-cli in a local development environment.

• Build with CLI overview: Getting started with CLI-based integration development.
• Core reference (zapier-platform-core): Reference for the core runtime package.
• Testing and debugging: Test with invoke and unit tests; debug locally.
• TypeScript integrations: TypeScript as a first-class language for CLI integrations.
• Making HTTP requests: How to call your API from a Zapier integration.
• Input Field Configuration: Configuring input fields for triggers and actions.
• Dynamic dropdowns: Populate dropdown fields from API data.
• Hydration: Deferred data loading for file handling.
• Empty values in input data: Handling empty values in bundle.inputData.
• Frequently Asked Questions
• Download source code: Download a zip of your CLI integration source.
• NPM package security incident (INC-547): Unauthorized access to Zapier NPM packages.

npm packages: zapier-platform-cli | zapier-platform-core Source: github.com/zapier/zapier-platform

---

Integration Builder — Building with Platform UI

Guides for building integrations using the visual Platform UI editor. Covers authentication, triggers, actions, testing, and troubleshooting.

Authentication

• Authentication overview: How app authentication works on Zapier.
• OAuth v2: The most common auth method for modern apps.
• API Key: Pass an API key with every request.
• Basic Auth: Username and password authentication.
• Session Auth: Credential exchange for a session token.
• Digest Auth: Challenge-response authentication.
• Computed fields: Use computed fields in OAuth or Session Auth.
• Computed test fields: Compute a field from the Test API call.
• Connection labels: Label multiple connected accounts.
• Request template auth fields: Set auth fields in the Request Template.
• Subdomain validation: Validate subdomain input to prevent security issues.
• Test authentication: Verify authentication works correctly.

Triggers

• Trigger overview: How triggers work on Zapier.
• Polling trigger: Triggers that check for new data periodically.
• REST Hook trigger: Instant triggers via webhooks.
• REST Hooks in CLI: Instant triggers using Platform CLI.
• Pagination in triggers: Handle large result sets.
• Deduplication: How Zapier prevents duplicate trigger events.
• Reorder or remove triggers: Manage trigger visibility in the editor.

Actions

• Action overview: How actions work in Zaps.
• Create action: Build a create action.
• Search action: Build a search/lookup action.
• Search or create: Find-or-create combo actions.
• Reorder or remove actions: Manage action visibility.

Input and output

• Input fields: Design forms users fill in for triggers and actions.
• Field types: Available field types and options.
• Dynamic fields: Fields populated from API data at runtime.
• Line item groups: Add multiple items in a single Zap run.
• Data bundles: Reference user-entered data in API calls.
• Response types: Expected response formats for triggers, actions, and searches.
• Sample data and output fields: Define output data for downstream steps.

API configuration

• Form mode: Set up API calls with the visual editor.
• Code mode: Refine API calls with custom code.
• Environment variables: Store secrets and toggle environments.
• Error handling: Handle non-standard error responses.
• Hydration/dehydration limits: Limits on deferred data loading.
• Operating constraints: Execution time, payload size, and runtime limits.
• Reduce API requests: Minimize unnecessary API calls.
• Static IP: Route outbound traffic through consistent IPs.

Testing

• Test and monitor: Test in the Zap editor and monitor behavior.
• Testing Tools: Built-in platform validation tools.
• Test triggers or actions: Run step-level tests.

Troubleshooting

• Action payload size
• Action timeouts
• Trigger payload size
• Trigger timeouts
• Custom fields
• Throttles
• Error: array expected
• Error: non-object from create
• Error: non-object in array
• Error: cannot retrieve app

---

Integration Builder — Managing

Guides for maintaining a live integration: versions, migrations, team management, and monitoring.

• Versions: How versioning works in the Developer Platform.
• Version lifecycle states: Private, promoted, available, legacy, deprecating, deprecated.
• Clone a version: Duplicate a version for safe iteration.
• Promote a version: Set a new default version for public use.
• Deprecate or delete a version: Phase out old versions.
• Labeled versions: Iterate without committing to a semantic version.
• Migrate users: Move users from one version to another.
• CI pipelines using Changesets: Automate version updates with changesets.
• Invite team members: Collaborate on your integration.
• Planning and implementing changes: Backwards compatibility and migration strategy.
• Share your integration: Make your integration accessible to users.
• Active users retention: Understanding and reducing churn.
• Respond to user feedback: Bug reports and feature requests from users.
• Integration insights: Health and depth metrics for your integration.
• Zap activation rates: Track how well users activate Zaps.
• Embed activation rates: Track embedded Zap performance.
• Embed insights: Analytics for your embeds.
• Essential tips for integration quality: Maintain quality for shared customers.
• Error handling improvements: Improve API error responses.
• API outage handling: What happens when your API is temporarily unavailable.
• Export to Platform CLI: Move from UI to CLI.
• Export to Platform UI: Move from CLI to UI.
• Manage legacy integrations
• Integration maintenance preferences: Opt in or out of Zapier's maintenance program.

Field and key changes

• Change authentication type
• Change auth field keys
• Add required auth field
• Change OAuth scope
• Change trigger or action key
• Change input form field key
• Change output field key
• Change output data response
• Add new required input field
• Update perform method
• Change trigger type (polling to hook)
• API changes impact

---

Integration Builder — Publishing

From first build to the Zapier App Directory: branding, checks, and partner benefits.

• Build your first public integration: Overview of the publishing process.
• Integration publishing requirements: What must be in place before submission.
• Integration build guidelines: Quality standards and best practices.
• Integration check reference: Automated checks your integration must pass.
• Add or modify branding: Name, description, logo, homepage URL.
• Branding in CLI: Set branding via package.json.
• Branding guidelines: Logo, color, and naming requirements.
• Best practices for showcasing: Marketing your integration effectively.
• Zap templates: Pre-built workflows to help users discover use cases.
• Partner Program: Benefits and tiers for integration partners.
• Partner benefits guide: Detailed breakdown of partner benefits.
• Integration success strategies: Growth tactics from top partners.
• Create help documentation: Write user-facing docs for your integration.
• Zapier Partner Sandbox: Complimentary account for integration development.

---

Integration Builder — Reference

Tutorials, app-type guides, and technical references for integration builders.

Tutorials

• Implementing OAuth v2
• Implementing REST Hook triggers
• Implementing error handling
• Creating dynamic dropdown fields
• Using dictionary fields
• Using environment variables
• Using the Request Template
• Monitoring tool walkthrough
• Cloning a version
• Promoting a version
• Managing team members
• Embedding the Workflow Element

App-type guides

• AI app integrations
• CRM app integrations
• Project management app integrations
• Forms app integrations

Technical references

• AI Actions: Zapier's AI Actions product for natural-language tool use.
• Custom actions and API requests
• Transfer (bulk operations)
• Legacy scripting: Scripting in converted legacy Web Builder integrations.
• CLI command reference: Redirects to github.com/zapier/zapier-platform CLI docs.
• Schema reference: Redirects to github.com/zapier/zapier-platform schema docs.

---

Powered by Zapier — Embedding

For developers embedding Zapier automation, MCP, and connections in their own products.

Root map: zapier.com/llms.txt#embed

• Powered by Zapier overview: Add automation to your product without building from scratch.
• Powered by Zapier (integration builder perspective): The embedding surface from the integration builder docs.

Embedding Zapier MCP

• Getting started with embedded MCP: Enable users to connect to apps and execute actions from your agent.
• Connecting your agent: Connect your agent to Zapier MCP servers.
• Getting embed code: Generate embed code snippets.

Embedded Zap editor

• Getting started: Embed a Zap editor in your product.
• Workflow Element: Prebuilt UI component for surfacing your integration.
• Pre-filled Zaps: Define input fields on behalf of the user.
• Element security
• Embed insights: Track embed performance.

Zap creation (Workflow API)

• Getting started: The most powerful tool for native workflows.
• How to build a workflow: Full workflow creation walkthrough.
• Retrieving apps: List available apps.
• Selecting an action: Choose actions for Zap steps.
• Fields and fieldsets: Input field handling.
• Filter actions: Conditional workflow logic.
• Selecting authentication: User auth selection.
• Hardcoding an action: Lock a step to a specific action.
• Testing a workflow: Validate configured steps.
• Retrieving Zaps: List a user's Zaps.
• Quick account creation: Accelerated sign-up for embedded users.
• Known limitations

Running actions

• Getting started: How to run an action.
• Creating action runs: Execute actions via API.
• Retrieving action run results: Get results of executed actions.

App authentication (embed)

• Getting started: App authentication concepts.
• Adding authentications: Reduce friction when adding auth.
• Get authentications: Retrieve a user's authentications.

Zap templates (embed)

• Getting started: Embed pre-built automations.
• Retrieving Zap Templates: Fetch templates for your integration.

AI workflows

• Zap Guesser: Generate Zap suggestions from natural language.

Sponsor user automation

• Getting started: Offer Zapier-powered automation without user billing.
• User enrollment: Enroll users in promotions.

API authentication

• Getting started: Authenticate with the Zapier Workflow API.
• App Access Token
• Client ID
• User Access Token

Versioning

• API versioning

---

White Label

Embed Zapier connections and automations under your own brand.

Root map: zapier.com/llms.txt#auth

• White Label overview: Brand-native Zapier connections and automations.
• Partner onboarding: JWKS, callbacks, JWT expectations, and client credentials.
• Connection flow: Popup or redirect flow for user connections.
• Token exchange: Exchange a JWT for access and connect tokens (MCP vs Actions/Triggers patterns).
• Error handling: Error codes for connection flow, token exchange, and refresh.

Use cases

• AI agent connections and automations: White Label + MCP with Streamable HTTP.
• Embedded triggers: Subscribe to real-time events from 9,000+ apps via the Trigger Inbox API.
• Embedded triggers/actions: Run actions from your product via Zapier APIs.
• Embedded workflows: Multi-step Zaps via the Workflow API.

Trigger Inbox API Reference

• Trigger Inbox OpenAPI spec: Full OpenAPI 3.1 spec for the Trigger Inbox API.
• Embedded triggers guide: End-to-end walkthrough of auth, trigger discovery, inbox creation, and message processing.

---

Workflow API Reference

REST API endpoints for the Powered by Zapier Workflow API.

Accounts

• Create Account: Create a user and obtain an access token.
• User Profile: Get the authenticated user.

Apps

• Get Apps (v1): List apps sorted by popularity.
• Get Apps (v2): List apps (v2 endpoint).

Authentications

• Create Authentication: Create a new auth for an app.
• Get Authentications: List a user's authentications.

Actions

• Get Actions: Fetch available actions for an app.
• Get Input Fields: Get input fields for an action.
• Get Output Fields: Get output fields for an action.
• Get Choices: Get values for a SELECT field.
• Create an Action Run: Execute actions.
• Retrieve Action Run: Get action run results.
• Step Test: Test an action step.

Zaps

• Create a Zap: Create a Zap from steps and title.
• Get Zaps (v1): List user's Zaps.
• Get Zaps (v2): List user's Zaps (v2).
• Guess a Zap (Beta): AI-suggested Zap from a prompt.

Zap Templates

• Get Zap Templates: List popular templates.

Categories

• Get Categories: List Zap categories.

Promotions

• Create Enrollment: Enroll an account in a promotion.
• Get Enrollment: Get enrollment details.
• Delete Enrollment: Unenroll from a promotion.

Experimental

• Get Whitelabel Apps (v2): Apps available for whitelabel connection.
• Get Zap Runs: Zap execution details.

Common types

• Common Types: Shared type definitions.
• App
• Action
• Authentication
• Zap
• InputField
• OutputField
• InfoField
• Fieldset
• Choice
• Errors
• Pagination
• Requests
• Responses

Rate limiting

• Rate Limiting

---

Platform News

Changelogs and platform updates for the Zapier Developer Platform (zapier-platform-cli / zapier-platform-core).

• Platform News hub: All changelogs and tips.
• Platform News (single page): All entries on one page.

2026

• News index (2026)
• v18.5.1: Actionable errors, platformData removed, zapier-platform binary name.
• v18.5.0: Line item support in invoke, falsy value fixes.
• v18.4.0: JSON input field type, versions improvements.
• v18.3.0: Bug fixes and improvements.
• v18.2.3: Bug fixes and improvements.
• v18.2.2: Legacy-scripting-runner module loading fix.
• v18.2.1: Build command symlink fix.
• v18.2.0: invoke supports function-based choices.
• v18.1.1: HTTP error log fix and security updates.
• v18.1.0: invoke --remote flag, package manager detection fix.
• v18.0.7: Publishing improvements, sample field in dynamic outputFields.
• Pushing versions must be sequential
• Migrations must stay within major version

2025

• News index (2025)
• v18.0.6: Package manager detection.
• v18.0.5: CLI security fix.
• v18.0.1: npx resolution and TypeScript typing fixes.
• v18.0.0: Node.js 22, throttling middleware, zapier-platform binary.
• v17.9.1: Push bug fix.
• v17.9.0: Search pagination, snapshot publishing.
• v17.8.0: Search Pagination groundwork.
• v17.7.2: Typing and semver fixes.
• v17.7.1: scaffold, init, validate, invoke improvements.
• v17.7.0: Search Pagination groundwork.
• v17.6.0: Global console, zapier canary filtering.
• v17.5.0: Global errors, build and auth field fixes.
• v17.4.0: Build fixes, large input bundle compression.
• v17.3.1: Build regression fixes.
• v17.3.0: Revamped zapier build, input field grouping.
• v17.2.0: Large bundle handling.
• v17.1.0: Improved zapier convert and zapier deprecate.
• v17.0.4: Build bug fix.
• v17.0.3: Build, curlies, and misc fixes.
• v17.0.2: Windows and ESM fixes.
• v17.0.1: Build and oauth2 template fix.
• v17.0.0: ES module support, complete typing, no more {{curlies}}.
• Labeled versions available
• Self-serve static IP
• 4xx errors in refreshAccessToken
• Organization-level migrations in UI
• NPM package security incident

---

OpenAPI Specs

• Workflow API schema
• Trigger Inbox API spec
• Promotions OpenAPI spec
• AI Actions OpenAPI spec

---

Optional

• Community
• Blog
• Contact developer support