# Zapier — docs.zapier.com > Local index for developer documentation — SDK, MCP, integration building, embedding, White Label. > Root map: [zapier.com/llms.txt](https://zapier.com/llms.txt) - [Documentation home](https://docs.zapier.com/index.md): Building integrations, building with the SDK, MCP, or embedding 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](https://zapier.com/llms.txt#sdk) - [Zapier SDK overview](https://docs.zapier.com/sdk/index.md): Let your agent connect to anything. Zapier handles the keys. - [Quickstart](https://docs.zapier.com/sdk/quickstart.md): Get up and running with the Zapier SDK in 5 minutes. - [API Reference](https://docs.zapier.com/sdk/reference.md): Complete reference for all Zapier SDK methods. - [CLI Reference](https://docs.zapier.com/sdk/cli-reference.md): Complete reference for all Zapier SDK CLI commands. - [Using the CLI](https://docs.zapier.com/sdk/using-the-cli.md): Walkthrough of common CLI workflows. - [Changelog](https://docs.zapier.com/sdk/changelog.md): Release history for the Zapier TypeScript SDK and CLI. npm packages: [`@zapier/zapier-sdk`](https://www.npmjs.com/package/@zapier/zapier-sdk) | [`@zapier/zapier-sdk-cli`](https://www.npmjs.com/package/@zapier/zapier-sdk-cli) | [`@zapier/zapier-sdk-core`](https://www.npmjs.com/package/@zapier/zapier-sdk-core) Source: [github.com/zapier/sdk](https://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](https://zapier.com/llms.txt#mcp) - [MCP home](https://docs.zapier.com/mcp/home.md): Overview of Zapier MCP and what it enables. - [Quickstart](https://docs.zapier.com/mcp/quickstart.md): Get up and running with Zapier MCP in 5 minutes. - [Supported clients](https://docs.zapier.com/mcp/clients.md): Which MCP clients work with Zapier (Claude, Cursor, VS Code, ChatGPT, etc.) and how to connect them. - [Usage and billing](https://docs.zapier.com/mcp/usage.md): How Zapier MCP usage works, rate limits, and pricing. - [Chatbot helper](https://docs.zapier.com/mcp/help/chat-bot.md): AI chatbot for MCP support questions. - [Community](https://docs.zapier.com/mcp/help/community.md): Join the Zapier MCP community. npm package: [`@zapier/zapier-sdk-mcp`](https://www.npmjs.com/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](https://zapier.com/llms.txt#developers) - [Welcome](https://docs.zapier.com/integrations/index.md): Integration Builder documentation home. - [How Zapier works](https://docs.zapier.com/integrations/quickstart/how-zapier-works.md): Conceptual overview of triggers, actions, and Zaps. - [Build your integration](https://docs.zapier.com/integrations/quickstart/build-integration.md): End-to-end guide from start to finish. - [Platform UI tutorial](https://docs.zapier.com/integrations/quickstart/ui-tutorial.md): Build an integration using the visual builder. - [Platform CLI tutorial](https://docs.zapier.com/integrations/quickstart/cli-tutorial.md): Build an integration using the CLI. - [Platform UI vs Platform CLI](https://docs.zapier.com/integrations/quickstart/ui-vs-cli.md): Which tool to use and when. - [Zapier integration structure](https://docs.zapier.com/integrations/quickstart/zapier-integration-structure.md): How integration projects are organized. - [Private vs public integrations](https://docs.zapier.com/integrations/quickstart/private-vs-public-integrations.md): Choosing your integration audience. - [Recommended triggers and actions](https://docs.zapier.com/integrations/quickstart/recommended-triggers-and-actions.md): What features users value most by app category. - [Glossary](https://docs.zapier.com/integrations/quickstart/glossary.md): Zapier-specific terms defined. - [Get help](https://docs.zapier.com/integrations/quickstart/get-help.md): Support channels for integration builders. - [App Developer Services](https://docs.zapier.com/integrations/quickstart/app-developer-services.md): Solution Partners who can build integrations for you. - [Integration platform login](https://docs.zapier.com/integrations/dev-platform-login.md): 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](https://docs.zapier.com/integrations/build-cli/overview.md): Getting started with CLI-based integration development. - [Core reference (`zapier-platform-core`)](https://docs.zapier.com/integrations/build-cli/core.md): Reference for the core runtime package. - [Testing and debugging](https://docs.zapier.com/integrations/build-cli/testing-and-debugging.md): Test with `invoke` and unit tests; debug locally. - [TypeScript integrations](https://docs.zapier.com/integrations/build-cli/typescript-integrations.md): TypeScript as a first-class language for CLI integrations. - [Making HTTP requests](https://docs.zapier.com/integrations/build-cli/making-http-requests.md): How to call your API from a Zapier integration. - [Input Field Configuration](https://docs.zapier.com/integrations/build-cli/input-fields.md): Configuring input fields for triggers and actions. - [Dynamic dropdowns](https://docs.zapier.com/integrations/build-cli/dynamic-dropdowns.md): Populate dropdown fields from API data. - [Hydration](https://docs.zapier.com/integrations/build-cli/hydration.md): Deferred data loading for file handling. - [Empty values in input data](https://docs.zapier.com/integrations/build-cli/empty-values-in-input-data.md): Handling empty values in `bundle.inputData`. - [Frequently Asked Questions](https://docs.zapier.com/integrations/build-cli/faqs.md) - [Download source code](https://docs.zapier.com/integrations/build-cli/download-source-code.md): Download a zip of your CLI integration source. - [NPM package security incident (INC-547)](https://docs.zapier.com/integrations/build-cli/inc-547.md): Unauthorized access to Zapier NPM packages. npm packages: [`zapier-platform-cli`](https://www.npmjs.com/package/zapier-platform-cli) | [`zapier-platform-core`](https://www.npmjs.com/package/zapier-platform-core) Source: [github.com/zapier/zapier-platform](https://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](https://docs.zapier.com/integrations/build/auth.md): How app authentication works on Zapier. - [OAuth v2](https://docs.zapier.com/integrations/build/oauth.md): The most common auth method for modern apps. - [API Key](https://docs.zapier.com/integrations/build/apikeyauth.md): Pass an API key with every request. - [Basic Auth](https://docs.zapier.com/integrations/build/basicauth.md): Username and password authentication. - [Session Auth](https://docs.zapier.com/integrations/build/sessionauth.md): Credential exchange for a session token. - [Digest Auth](https://docs.zapier.com/integrations/build/digestauth.md): Challenge-response authentication. - [Computed fields](https://docs.zapier.com/integrations/build/computed-fields.md): Use computed fields in OAuth or Session Auth. - [Computed test fields](https://docs.zapier.com/integrations/build/computed-test-field.md): Compute a field from the Test API call. - [Connection labels](https://docs.zapier.com/integrations/build/connection-label.md): Label multiple connected accounts. - [Request template auth fields](https://docs.zapier.com/integrations/build/requesttemplate.md): Set auth fields in the Request Template. - [Subdomain validation](https://docs.zapier.com/integrations/build/subdomain-validation.md): Validate subdomain input to prevent security issues. - [Test authentication](https://docs.zapier.com/integrations/build/test-auth.md): Verify authentication works correctly. ### Triggers - [Trigger overview](https://docs.zapier.com/integrations/build/trigger.md): How triggers work on Zapier. - [Polling trigger](https://docs.zapier.com/integrations/build/polling-trigger.md): Triggers that check for new data periodically. - [REST Hook trigger](https://docs.zapier.com/integrations/build/hook-trigger.md): Instant triggers via webhooks. - [REST Hooks in CLI](https://docs.zapier.com/integrations/build/cli-hook-trigger.md): Instant triggers using Platform CLI. - [Pagination in triggers](https://docs.zapier.com/integrations/build/pagination-trigger.md): Handle large result sets. - [Deduplication](https://docs.zapier.com/integrations/build/deduplication.md): How Zapier prevents duplicate trigger events. - [Reorder or remove triggers](https://docs.zapier.com/integrations/build/reorder-trigger.md): Manage trigger visibility in the editor. ### Actions - [Action overview](https://docs.zapier.com/integrations/build/action.md): How actions work in Zaps. - [Create action](https://docs.zapier.com/integrations/build/create.md): Build a create action. - [Search action](https://docs.zapier.com/integrations/build/search.md): Build a search/lookup action. - [Search or create](https://docs.zapier.com/integrations/build/search-or-create.md): Find-or-create combo actions. - [Reorder or remove actions](https://docs.zapier.com/integrations/build/reorder-action.md): Manage action visibility. ### Input and output - [Input fields](https://docs.zapier.com/integrations/build/add-fields.md): Design forms users fill in for triggers and actions. - [Field types](https://docs.zapier.com/integrations/build/field-definitions.md): Available field types and options. - [Dynamic fields](https://docs.zapier.com/integrations/build/dynamic-field.md): Fields populated from API data at runtime. - [Line item groups](https://docs.zapier.com/integrations/build/line-items.md): Add multiple items in a single Zap run. - [Data bundles](https://docs.zapier.com/integrations/build/bundle.md): Reference user-entered data in API calls. - [Response types](https://docs.zapier.com/integrations/build/response-types.md): Expected response formats for triggers, actions, and searches. - [Sample data and output fields](https://docs.zapier.com/integrations/build/sample-data.md): Define output data for downstream steps. ### API configuration - [Form mode](https://docs.zapier.com/integrations/build/form-mode.md): Set up API calls with the visual editor. - [Code mode](https://docs.zapier.com/integrations/build/code-mode.md): Refine API calls with custom code. - [Environment variables](https://docs.zapier.com/integrations/build/env.md): Store secrets and toggle environments. - [Error handling](https://docs.zapier.com/integrations/build/errors.md): Handle non-standard error responses. - [Hydration/dehydration limits](https://docs.zapier.com/integrations/build/hydration-limits.md): Limits on deferred data loading. - [Operating constraints](https://docs.zapier.com/integrations/build/operating-constraints.md): Execution time, payload size, and runtime limits. - [Reduce API requests](https://docs.zapier.com/integrations/build/reduce-api-requests.md): Minimize unnecessary API calls. - [Static IP](https://docs.zapier.com/integrations/build/static-ip.md): Route outbound traffic through consistent IPs. ### Testing - [Test and monitor](https://docs.zapier.com/integrations/build/test-monitoring.md): Test in the Zap editor and monitor behavior. - [Testing Tools](https://docs.zapier.com/integrations/build/test-tools.md): Built-in platform validation tools. - [Test triggers or actions](https://docs.zapier.com/integrations/build/test-triggers-actions.md): Run step-level tests. ### Troubleshooting - [Action payload size](https://docs.zapier.com/integrations/build/troubleshoot-action-payload.md) - [Action timeouts](https://docs.zapier.com/integrations/build/troubleshoot-action-timeouts.md) - [Trigger payload size](https://docs.zapier.com/integrations/build/troubleshoot-trigger-payload.md) - [Trigger timeouts](https://docs.zapier.com/integrations/build/troubleshoot-trigger-timeouts.md) - [Custom fields](https://docs.zapier.com/integrations/build/troubleshoot-custom-fields.md) - [Throttles](https://docs.zapier.com/integrations/build/troubleshoot-throttles.md) - [Error: array expected](https://docs.zapier.com/integrations/build/error-array-expected.md) - [Error: non-object from create](https://docs.zapier.com/integrations/build/error-non-object.md) - [Error: non-object in array](https://docs.zapier.com/integrations/build/error-non-object-array.md) - [Error: cannot retrieve app](https://docs.zapier.com/integrations/build/error-cannot-retrieve-app.md) --- ## Integration Builder — Managing Guides for maintaining a live integration: versions, migrations, team management, and monitoring. - [Versions](https://docs.zapier.com/integrations/manage/versions.md): How versioning works in the Developer Platform. - [Version lifecycle states](https://docs.zapier.com/integrations/manage/version-lifecycle-states.md): Private, promoted, available, legacy, deprecating, deprecated. - [Clone a version](https://docs.zapier.com/integrations/manage/clone.md): Duplicate a version for safe iteration. - [Promote a version](https://docs.zapier.com/integrations/manage/promote.md): Set a new default version for public use. - [Deprecate or delete a version](https://docs.zapier.com/integrations/manage/deprecate.md): Phase out old versions. - [Labeled versions](https://docs.zapier.com/integrations/manage/labeled-versions.md): Iterate without committing to a semantic version. - [Migrate users](https://docs.zapier.com/integrations/manage/migrate.md): Move users from one version to another. - [CI pipelines using Changesets](https://docs.zapier.com/integrations/manage/changeset-workflow.md): Automate version updates with changesets. - [Invite team members](https://docs.zapier.com/integrations/manage/add-team.md): Collaborate on your integration. - [Planning and implementing changes](https://docs.zapier.com/integrations/manage/planning-changes.md): Backwards compatibility and migration strategy. - [Share your integration](https://docs.zapier.com/integrations/manage/sharing.md): Make your integration accessible to users. - [Active users retention](https://docs.zapier.com/integrations/manage/active-users.md): Understanding and reducing churn. - [Respond to user feedback](https://docs.zapier.com/integrations/manage/user-feedback.md): Bug reports and feature requests from users. - [Integration insights](https://docs.zapier.com/integrations/manage/integration-insights.md): Health and depth metrics for your integration. - [Zap activation rates](https://docs.zapier.com/integrations/manage/zap-activation.md): Track how well users activate Zaps. - [Embed activation rates](https://docs.zapier.com/integrations/manage/embed-activation.md): Track embedded Zap performance. - [Embed insights](https://docs.zapier.com/integrations/manage/embed-insights.md): Analytics for your embeds. - [Essential tips for integration quality](https://docs.zapier.com/integrations/manage/essential-tips-iq.md): Maintain quality for shared customers. - [Error handling improvements](https://docs.zapier.com/integrations/manage/error-handling.md): Improve API error responses. - [API outage handling](https://docs.zapier.com/integrations/manage/api-outage.md): What happens when your API is temporarily unavailable. - [Export to Platform CLI](https://docs.zapier.com/integrations/manage/export-cli.md): Move from UI to CLI. - [Export to Platform UI](https://docs.zapier.com/integrations/manage/export-ui.md): Move from CLI to UI. - [Manage legacy integrations](https://docs.zapier.com/integrations/manage/versions-legacy.md) - [Integration maintenance preferences](https://docs.zapier.com/integrations/manage/manage-integration-maintenance-preference.md): Opt in or out of Zapier's maintenance program. ### Field and key changes - [Change authentication type](https://docs.zapier.com/integrations/manage/auth-scheme.md) - [Change auth field keys](https://docs.zapier.com/integrations/manage/auth-keys.md) - [Add required auth field](https://docs.zapier.com/integrations/manage/auth-required.md) - [Change OAuth scope](https://docs.zapier.com/integrations/manage/auth-scope.md) - [Change trigger or action key](https://docs.zapier.com/integrations/manage/change-keys.md) - [Change input form field key](https://docs.zapier.com/integrations/manage/input-key.md) - [Change output field key](https://docs.zapier.com/integrations/manage/output-key.md) - [Change output data response](https://docs.zapier.com/integrations/manage/output.md) - [Add new required input field](https://docs.zapier.com/integrations/manage/required-input.md) - [Update perform method](https://docs.zapier.com/integrations/manage/change-perform.md) - [Change trigger type (polling to hook)](https://docs.zapier.com/integrations/manage/change-trigger.md) - [API changes impact](https://docs.zapier.com/integrations/manage/change-api.md) --- ## Integration Builder — Publishing From first build to the Zapier App Directory: branding, checks, and partner benefits. - [Build your first public integration](https://docs.zapier.com/integrations/publish/public-integration.md): Overview of the publishing process. - [Integration publishing requirements](https://docs.zapier.com/integrations/publish/integration-publishing-requirements.md): What must be in place before submission. - [Integration build guidelines](https://docs.zapier.com/integrations/publish/integration-build-guidelines.md): Quality standards and best practices. - [Integration check reference](https://docs.zapier.com/integrations/publish/integration-checks-reference.md): Automated checks your integration must pass. - [Add or modify branding](https://docs.zapier.com/integrations/publish/add-or-modify-branding.md): Name, description, logo, homepage URL. - [Branding in CLI](https://docs.zapier.com/integrations/publish/branding-cli.md): Set branding via `package.json`. - [Branding guidelines](https://docs.zapier.com/integrations/publish/branding-guidelines.md): Logo, color, and naming requirements. - [Best practices for showcasing](https://docs.zapier.com/integrations/publish/best-practices.md): Marketing your integration effectively. - [Zap templates](https://docs.zapier.com/integrations/publish/zap-templates.md): Pre-built workflows to help users discover use cases. - [Partner Program](https://docs.zapier.com/integrations/publish/partner-program.md): Benefits and tiers for integration partners. - [Partner benefits guide](https://docs.zapier.com/integrations/publish/benefits-guide.md): Detailed breakdown of partner benefits. - [Integration success strategies](https://docs.zapier.com/integrations/publish/partner-faq.md): Growth tactics from top partners. - [Create help documentation](https://docs.zapier.com/integrations/publish/user-help.md): Write user-facing docs for your integration. - [Zapier Partner Sandbox](https://docs.zapier.com/integrations/publish/zps.md): Complimentary account for integration development. --- ## Integration Builder — Reference Tutorials, app-type guides, and technical references for integration builders. ### Tutorials - [Implementing OAuth v2](https://docs.zapier.com/integrations/reference/implementing-oauth-tutorial.md) - [Implementing REST Hook triggers](https://docs.zapier.com/integrations/reference/rest-hook-trigger-tutorial.md) - [Implementing error handling](https://docs.zapier.com/integrations/reference/error-handling-tutorial.md) - [Creating dynamic dropdown fields](https://docs.zapier.com/integrations/reference/dynamic-dropdown-tutorial.md) - [Using dictionary fields](https://docs.zapier.com/integrations/reference/dictionary-fields-tutorial.md) - [Using environment variables](https://docs.zapier.com/integrations/reference/using-environment-variables-tutorial.md) - [Using the Request Template](https://docs.zapier.com/integrations/reference/request-template-tutorial.md) - [Monitoring tool walkthrough](https://docs.zapier.com/integrations/reference/monitoring-tool-tutorial.md) - [Cloning a version](https://docs.zapier.com/integrations/reference/cloning-a-version-tutorial.md) - [Promoting a version](https://docs.zapier.com/integrations/reference/promoting-a-version-tutorial.md) - [Managing team members](https://docs.zapier.com/integrations/reference/managing-team-tutorial.md) - [Embedding the Workflow Element](https://docs.zapier.com/integrations/reference/zapier-workflow-element-tutorial.md) ### App-type guides - [AI app integrations](https://docs.zapier.com/integrations/reference/ai-app.md) - [CRM app integrations](https://docs.zapier.com/integrations/reference/crm-app.md) - [Project management app integrations](https://docs.zapier.com/integrations/reference/project-app.md) - [Forms app integrations](https://docs.zapier.com/integrations/reference/forms-app.md) ### Technical references - [AI Actions](https://docs.zapier.com/integrations/reference/ai-actions.md): Zapier's AI Actions product for natural-language tool use. - [Custom actions and API requests](https://docs.zapier.com/integrations/reference/custom-actions-api-requests.md) - [Transfer (bulk operations)](https://docs.zapier.com/integrations/reference/transfer.md) - [Legacy scripting](https://docs.zapier.com/integrations/reference/legacy-scripting.md): Scripting in converted legacy Web Builder integrations. - [CLI command reference](https://docs.zapier.com/integrations/reference/cli.md): Redirects to [github.com/zapier/zapier-platform CLI docs](https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md). - [Schema reference](https://docs.zapier.com/integrations/reference/schema.md): Redirects to [github.com/zapier/zapier-platform schema docs](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md). --- ## Powered by Zapier — Embedding For developers embedding Zapier automation, MCP, and connections in their own products. > Root map: [zapier.com/llms.txt#embed](https://zapier.com/llms.txt#embed) - [Powered by Zapier overview](https://docs.zapier.com/powered-by-zapier/index.md): Add automation to your product without building from scratch. - [Powered by Zapier (integration builder perspective)](https://docs.zapier.com/integrations/embed/powered-by-zapier.md): The embedding surface from the integration builder docs. ### Embedding Zapier MCP - [Getting started with embedded MCP](https://docs.zapier.com/powered-by-zapier/embedding-zapier-mcp/getting-started.md): Enable users to connect to apps and execute actions from your agent. - [Connecting your agent](https://docs.zapier.com/powered-by-zapier/embedding-zapier-mcp/guides/connecting-your-agent.md): Connect your agent to Zapier MCP servers. - [Getting embed code](https://docs.zapier.com/powered-by-zapier/embedding-zapier-mcp/guides/getting-embed-code.md): Generate embed code snippets. ### Embedded Zap editor - [Getting started](https://docs.zapier.com/powered-by-zapier/embedding-zapier/getting-started.md): Embed a Zap editor in your product. - [Workflow Element](https://docs.zapier.com/powered-by-zapier/embedding-zapier/workflow-element.md): Prebuilt UI component for surfacing your integration. - [Pre-filled Zaps](https://docs.zapier.com/powered-by-zapier/embedding-zapier/pre-filled-zaps.md): Define input fields on behalf of the user. - [Element security](https://docs.zapier.com/powered-by-zapier/embedding-zapier/elements-security.md) - [Embed insights](https://docs.zapier.com/powered-by-zapier/embedding-zapier/embed-insights.md): Track embed performance. ### Zap creation (Workflow API) - [Getting started](https://docs.zapier.com/powered-by-zapier/zap-creation/getting-started.md): The most powerful tool for native workflows. - [How to build a workflow](https://docs.zapier.com/powered-by-zapier/zap-creation/how-to-build-a-workflow.md): Full workflow creation walkthrough. - [Retrieving apps](https://docs.zapier.com/powered-by-zapier/zap-creation/retrieving-apps.md): List available apps. - [Selecting an action](https://docs.zapier.com/powered-by-zapier/zap-creation/selecting-an-action.md): Choose actions for Zap steps. - [Fields and fieldsets](https://docs.zapier.com/powered-by-zapier/zap-creation/fields-and-fieldsets.md): Input field handling. - [Filter actions](https://docs.zapier.com/powered-by-zapier/zap-creation/filter-actions.md): Conditional workflow logic. - [Selecting authentication](https://docs.zapier.com/powered-by-zapier/zap-creation/selecting-an-authentication.md): User auth selection. - [Hardcoding an action](https://docs.zapier.com/powered-by-zapier/zap-creation/hardcoding-an-action.md): Lock a step to a specific action. - [Testing a workflow](https://docs.zapier.com/powered-by-zapier/zap-creation/testing-a-workflow.md): Validate configured steps. - [Retrieving Zaps](https://docs.zapier.com/powered-by-zapier/zap-creation/retrieving-a-list-of-zaps.md): List a user's Zaps. - [Quick account creation](https://docs.zapier.com/powered-by-zapier/zap-creation/quick-account-creation.md): Accelerated sign-up for embedded users. - [Known limitations](https://docs.zapier.com/powered-by-zapier/zap-creation/known-limitations.md) ### Running actions - [Getting started](https://docs.zapier.com/powered-by-zapier/running-actions/getting-started.md): How to run an action. - [Creating action runs](https://docs.zapier.com/powered-by-zapier/running-actions/create-action-run.md): Execute actions via API. - [Retrieving action run results](https://docs.zapier.com/powered-by-zapier/running-actions/retrieve-action-run.md): Get results of executed actions. ### App authentication (embed) - [Getting started](https://docs.zapier.com/powered-by-zapier/managing-app-authentication/getting-started.md): App authentication concepts. - [Adding authentications](https://docs.zapier.com/powered-by-zapier/managing-app-authentication/adding-app-authentications.md): Reduce friction when adding auth. - [Get authentications](https://docs.zapier.com/powered-by-zapier/managing-app-authentication/get-authentications.md): Retrieve a user's authentications. ### Zap templates (embed) - [Getting started](https://docs.zapier.com/powered-by-zapier/zap-templates/getting-started.md): Embed pre-built automations. - [Retrieving Zap Templates](https://docs.zapier.com/powered-by-zapier/zap-templates/retrieving-zap-templates.md): Fetch templates for your integration. ### AI workflows - [Zap Guesser](https://docs.zapier.com/powered-by-zapier/ai-workflows/zap-guesser.md): Generate Zap suggestions from natural language. ### Sponsor user automation - [Getting started](https://docs.zapier.com/powered-by-zapier/sponsor-user-automation/getting-started.md): Offer Zapier-powered automation without user billing. - [User enrollment](https://docs.zapier.com/powered-by-zapier/sponsor-user-automation/user-enrollment.md): Enroll users in promotions. ### API authentication - [Getting started](https://docs.zapier.com/powered-by-zapier/authentication/getting-started.md): Authenticate with the Zapier Workflow API. - [App Access Token](https://docs.zapier.com/powered-by-zapier/authentication/methods/app-access-token.md) - [Client ID](https://docs.zapier.com/powered-by-zapier/authentication/methods/client-id.md) - [User Access Token](https://docs.zapier.com/powered-by-zapier/authentication/methods/user-access-token.md) ### Versioning - [API versioning](https://docs.zapier.com/powered-by-zapier/versioning.md) --- ## White Label Embed Zapier connections and automations under your own brand. > Root map: [zapier.com/llms.txt#auth](https://zapier.com/llms.txt#auth) - [White Label overview](https://docs.zapier.com/white-label/getting-started.md): Brand-native Zapier connections and automations. - [Partner onboarding](https://docs.zapier.com/white-label/partner-onboarding.md): JWKS, callbacks, JWT expectations, and client credentials. - [Connection flow](https://docs.zapier.com/white-label/connection-flow.md): Popup or redirect flow for user connections. - [Token exchange](https://docs.zapier.com/white-label/token-exchange.md): Exchange a JWT for access and connect tokens (MCP vs Actions/Triggers patterns). - [Error handling](https://docs.zapier.com/white-label/error-handling.md): Error codes for connection flow, token exchange, and refresh. ### Use cases - [AI agent connections and automations](https://docs.zapier.com/white-label/use-cases/ai-agent-connections.md): White Label + MCP with Streamable HTTP. - [Embedded triggers/actions](https://docs.zapier.com/white-label/use-cases/embedded-triggers-actions.md): Run actions from your product via Zapier APIs. - [Embedded workflows](https://docs.zapier.com/white-label/use-cases/embedded-workflows.md): Multi-step Zaps via the Workflow API. --- ## Workflow API Reference REST API endpoints for the Powered by Zapier Workflow API. ### Accounts - [Create Account](https://docs.zapier.com/powered-by-zapier/api-reference/accounts/create-account.md): Create a user and obtain an access token. - [User Profile](https://docs.zapier.com/powered-by-zapier/api-reference/accounts/user-profile.md): Get the authenticated user. ### Apps - [Get Apps (v1)](https://docs.zapier.com/powered-by-zapier/api-reference/apps/get-apps-[v1].md): List apps sorted by popularity. - [Get Apps (v2)](https://docs.zapier.com/powered-by-zapier/api-reference/apps/get-apps-[v2].md): List apps (v2 endpoint). ### Authentications - [Create Authentication](https://docs.zapier.com/powered-by-zapier/api-reference/authentications/create-authentication.md): Create a new auth for an app. - [Get Authentications](https://docs.zapier.com/powered-by-zapier/api-reference/authentications/get-authentications.md): List a user's authentications. ### Actions - [Get Actions](https://docs.zapier.com/powered-by-zapier/api-reference/actions/get-actions.md): Fetch available actions for an app. - [Get Input Fields](https://docs.zapier.com/powered-by-zapier/api-reference/actions/get-input-fields.md): Get input fields for an action. - [Get Output Fields](https://docs.zapier.com/powered-by-zapier/api-reference/actions/get-output-fields.md): Get output fields for an action. - [Get Choices](https://docs.zapier.com/powered-by-zapier/api-reference/actions/get-choices.md): Get values for a SELECT field. - [Create an Action Run](https://docs.zapier.com/powered-by-zapier/api-reference/actions/create-an-action-run.md): Execute actions. - [Retrieve Action Run](https://docs.zapier.com/powered-by-zapier/api-reference/actions/retrieve-action-run.md): Get action run results. - [Step Test](https://docs.zapier.com/powered-by-zapier/api-reference/actions/step-test.md): Test an action step. ### Zaps - [Create a Zap](https://docs.zapier.com/powered-by-zapier/api-reference/zaps/create-a-zap.md): Create a Zap from steps and title. - [Get Zaps (v1)](https://docs.zapier.com/powered-by-zapier/api-reference/zaps/get-zaps-[v1].md): List user's Zaps. - [Get Zaps (v2)](https://docs.zapier.com/powered-by-zapier/api-reference/zaps/get-zaps-[v2].md): List user's Zaps (v2). - [Guess a Zap (Beta)](https://docs.zapier.com/powered-by-zapier/api-reference/zaps/guess-a-zap.md): AI-suggested Zap from a prompt. ### Zap Templates - [Get Zap Templates](https://docs.zapier.com/powered-by-zapier/api-reference/zap-templates/get-zap-templates.md): List popular templates. ### Categories - [Get Categories](https://docs.zapier.com/powered-by-zapier/api-reference/categories/get-categories.md): List Zap categories. ### Promotions - [Create Enrollment](https://docs.zapier.com/powered-by-zapier/api-reference/promotions/create-enrollment.md): Enroll an account in a promotion. - [Get Enrollment](https://docs.zapier.com/powered-by-zapier/api-reference/promotions/get-enrollment.md): Get enrollment details. - [Delete Enrollment](https://docs.zapier.com/powered-by-zapier/api-reference/promotions/delete-enrollment.md): Unenroll from a promotion. ### Experimental - [Get Whitelabel Apps (v2)](https://docs.zapier.com/powered-by-zapier/api-reference/experimental/get-whitelabel-apps.md): Apps available for whitelabel connection. - [Get Zap Runs](https://docs.zapier.com/powered-by-zapier/api-reference/experimental/get-zap-runs.md): Zap execution details. ### Common types - [Common Types](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/common-types.md): Shared type definitions. - [App](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app.md) - [Action](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/action.md) - [Authentication](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/authentication.md) - [Zap](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/zap.md) - [InputField](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/inputField.md) - [OutputField](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/outputField.md) - [InfoField](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/infoField.md) - [Fieldset](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/fieldset.md) - [Choice](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/choice.md) - [Errors](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/errors.md) - [Pagination](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/pagination.md) - [Requests](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/requests.md) - [Responses](https://docs.zapier.com/powered-by-zapier/api-reference/common-types/responses.md) ### Rate limiting - [Rate Limiting](https://docs.zapier.com/powered-by-zapier/api-reference/rate-limiting.md) --- ## Platform News Changelogs and platform updates for the Zapier Developer Platform (`zapier-platform-cli` / `zapier-platform-core`). - [Platform News hub](https://docs.zapier.com/integrations/news.md): All changelogs and tips. - [Platform News (single page)](https://docs.zapier.com/integrations/news/single-page.md): All entries on one page. ### 2026 - [News index (2026)](https://docs.zapier.com/integrations/news/2026/index.md) - [v18.5.1](https://docs.zapier.com/integrations/news/2026/v18.5.1.md): Actionable errors, `platformData` removed, `zapier-platform` binary name. - [v18.5.0](https://docs.zapier.com/integrations/news/2026/v18.5.0.md): Line item support in `invoke`, falsy value fixes. - [v18.4.0](https://docs.zapier.com/integrations/news/2026/v18.4.0.md): JSON input field type, `versions` improvements. - [v18.3.0](https://docs.zapier.com/integrations/news/2026/v18.3.0.md): Bug fixes and improvements. - [v18.2.3](https://docs.zapier.com/integrations/news/2026/v18.2.3.md): Bug fixes and improvements. - [v18.2.2](https://docs.zapier.com/integrations/news/2026/v18.2.2.md): Legacy-scripting-runner module loading fix. - [v18.2.1](https://docs.zapier.com/integrations/news/2026/v18.2.1.md): Build command symlink fix. - [v18.2.0](https://docs.zapier.com/integrations/news/2026/v18.2.0.md): invoke supports function-based choices. - [v18.1.1](https://docs.zapier.com/integrations/news/2026/v18.1.1.md): HTTP error log fix and security updates. - [v18.1.0](https://docs.zapier.com/integrations/news/2026/v18.1.0.md): `invoke --remote` flag, package manager detection fix. - [v18.0.7](https://docs.zapier.com/integrations/news/2026/v18.0.7.md): Publishing improvements, `sample` field in dynamic outputFields. - [Pushing versions must be sequential](https://docs.zapier.com/integrations/news/2026/no-skip-or-intermediate-versions.md) - [Migrations must stay within major version](https://docs.zapier.com/integrations/news/2026/migrations-same-major-version.md) ### 2025 - [News index (2025)](https://docs.zapier.com/integrations/news/2025/index.md) - [v18.0.6](https://docs.zapier.com/integrations/news/2025/v18.0.6.md): Package manager detection. - [v18.0.5](https://docs.zapier.com/integrations/news/2025/v18.0.5.md): CLI security fix. - [v18.0.1](https://docs.zapier.com/integrations/news/2025/v18.0.1.md): npx resolution and TypeScript typing fixes. - [v18.0.0](https://docs.zapier.com/integrations/news/2025/v18.0.0.md): Node.js 22, throttling middleware, `zapier-platform` binary. - [v17.9.1](https://docs.zapier.com/integrations/news/2025/v17.9.1.md): Push bug fix. - [v17.9.0](https://docs.zapier.com/integrations/news/2025/v17.9.0.md): Search pagination, snapshot publishing. - [v17.8.0](https://docs.zapier.com/integrations/news/2025/v17.8.0.md): Search Pagination groundwork. - [v17.7.2](https://docs.zapier.com/integrations/news/2025/v17.7.2.md): Typing and semver fixes. - [v17.7.1](https://docs.zapier.com/integrations/news/2025/v17.7.1.md): scaffold, init, validate, invoke improvements. - [v17.7.0](https://docs.zapier.com/integrations/news/2025/v17.7.0.md): Search Pagination groundwork. - [v17.6.0](https://docs.zapier.com/integrations/news/2025/v17.6.0.md): Global `console`, `zapier canary` filtering. - [v17.5.0](https://docs.zapier.com/integrations/news/2025/v17.5.0.md): Global `errors`, build and auth field fixes. - [v17.4.0](https://docs.zapier.com/integrations/news/2025/v17.4.0.md): Build fixes, large input bundle compression. - [v17.3.1](https://docs.zapier.com/integrations/news/2025/v17.3.1.md): Build regression fixes. - [v17.3.0](https://docs.zapier.com/integrations/news/2025/v17.3.0.md): Revamped `zapier build`, input field grouping. - [v17.2.0](https://docs.zapier.com/integrations/news/2025/v17.2.0.md): Large bundle handling. - [v17.1.0](https://docs.zapier.com/integrations/news/2025/v17.1.0.md): Improved `zapier convert` and `zapier deprecate`. - [v17.0.4](https://docs.zapier.com/integrations/news/2025/v17.0.4.md): Build bug fix. - [v17.0.3](https://docs.zapier.com/integrations/news/2025/v17.0.3.md): Build, curlies, and misc fixes. - [v17.0.2](https://docs.zapier.com/integrations/news/2025/v17.0.2.md): Windows and ESM fixes. - [v17.0.1](https://docs.zapier.com/integrations/news/2025/v17.0.1.md): Build and oauth2 template fix. - [v17.0.0](https://docs.zapier.com/integrations/news/2025/v17.0.0.md): ES module support, complete typing, no more `{{curlies}}`. - [Labeled versions available](https://docs.zapier.com/integrations/news/2025/labeled-versions.md) - [Self-serve static IP](https://docs.zapier.com/integrations/news/2025/static-ip-self-serve.md) - [4xx errors in refreshAccessToken](https://docs.zapier.com/integrations/news/2025/4xx-errors-refreshAccessToken.md) - [Organization-level migrations in UI](https://docs.zapier.com/integrations/news/2025/organization-user-migration-in-ui.md) - [NPM package security incident](https://docs.zapier.com/integrations/news/2025/npm-package-sec-inc.md) --- ## OpenAPI Specs - [Workflow API schema](https://api.zapier.com/schema) - [Promotions OpenAPI spec](https://docs.zapier.com/powered-by-zapier/api-reference/promotions-openapi.yaml) - [AI Actions OpenAPI spec](https://docs.zapier.com/ai-actions/openapi.json) --- ## Optional - [Community](https://community.zapier.com/) - [Blog](https://zapier.com/blog/) - [Contact developer support](https://developer.zapier.com/contact)