Zapier Platform CLI

Free v1.0.0

Build, test, and deploy custom Zapier integrations using the Platform CLI with JavaScript/TypeScript

Requires Claude Code CLI

This skill integrates with Zapier Platform through Claude Code. Install Claude Code and add this skill to use it.

Available Actions

Create New Integration

Initialize a new Zapier integration project from a template (minimal, basic-auth, custom-auth, oauth2, session-auth)

Parameters

Name Type Required Description
path string Required Directory path for the new integration
template string Optional Template to use
language string Optional Programming language

Try saying...

  • "Create a new Zapier integration called my-app"
  • "Initialize a Zapier integration with OAuth2 authentication"
  • "Set up a new integration project using the minimal template"

Register Integration

Register a new integration with Zapier or update existing integration metadata

Parameters

Name Type Required Description
title string Optional Integration title (interactive prompt if not provided)

Try saying...

  • "Register this integration with Zapier as 'My Cool App'"
  • "Create a new Zapier integration in my account"

Generate Code Scaffolding

Generate trigger, search, create, or resource files with boilerplate code

Parameters

Name Type Required Description
actiontype string Required Type of action to scaffold
noun string Required Name/noun for the action

Try saying...

  • "Generate a new trigger for incoming messages"
  • "Scaffold a search action for finding users"
  • "Create a resource for managing contacts"

Validate Integration

Run structural checks and linting on integration code

Try saying...

  • "Validate my Zapier integration code"
  • "Check for integration errors"
  • "Run validation checks"

Test Integration

Run the integration's test suite (wraps npm test with validation)

Try saying...

  • "Run tests for my Zapier integration"
  • "Test my integration code"
  • "Execute the test suite"

Test Locally (Invoke)

Test authentication, triggers, and actions locally or remotely without deploying

Parameters

Name Type Required Description
actiontype string Optional Type of action to invoke
actionkey string Optional Key/name of the specific action

Try saying...

  • "Test the new_contact trigger locally"
  • "Test authentication with my credentials"
  • "Invoke the find_user search action"

Deploy Integration

Build and upload integration to Zapier (creates new version or snapshot)

Parameters

Name Type Required Description
snapshot string Optional Label for development snapshot (doesn't create permanent version)

Try saying...

  • "Deploy my integration to Zapier"
  • "Push a development snapshot for testing"
  • "Upload the latest version"

Promote Version

Make a version publicly available to new users (does not migrate existing users)

Parameters

Name Type Required Description
version string Required Version number to promote

Try saying...

  • "Promote version 1.0.1 to production"
  • "Make version 1.0.0 publicly available"

Migrate Users

Move users from one version to another (gradual or complete migration)

Parameters

Name Type Required Description
fromversion string Required Source version
toversion string Required Target version
percent integer Optional Percentage of users to migrate (1-100)

Try saying...

  • "Migrate 10% of users from version 1.0.0 to 1.0.1"
  • "Migrate all users to the new version"
  • "Move users to version 1.1.0"

Set Environment Variables

Set environment variables for a specific version

Parameters

Name Type Required Description
version string Required Version number
key_value_pairs string[] Required Environment variables as KEY=VALUE pairs

Try saying...

  • "Set API_KEY environment variable for version 1.0.1"
  • "Add API_ENDPOINT configuration to version 1.0.0"

View Logs

Access execution logs from Zapier's production environment

Parameters

Name Type Required Description
version string Optional Filter by version
status string Optional Filter by status
type string Optional Log type to view

Try saying...

  • "Show recent errors from my integration"
  • "View HTTP logs for version 1.0.1"
  • "Display console logs"

Manage Team

Add, list, or remove team members with different permission levels

Parameters

Name Type Required Description
email string Required Team member's email
role string Required Permission level

Try saying...

  • "Add jane@example.com as an admin"
  • "Invite a collaborator to the team"
  • "List team members"

Manage Users

Invite specific users to test your integration or revoke access

Parameters

Name Type Required Description
email string Required User's email address
version string Optional Specific version to grant access to

Try saying...

  • "Invite beta@example.com to test my integration"
  • "Add a user to version 1.0.1"
  • "Generate invitation links"

Convert from Visual Builder

Transform a Visual Builder integration to CLI format

Parameters

Name Type Required Description
path string Required Target directory path
integrationId integer Required Integration ID from Visual Builder
version string Required Version number for converted integration

Try saying...

  • "Convert my Visual Builder integration to CLI"
  • "Migrate integration 12345 to CLI format"

Getting Started

CLI Authentication Easy Setup
  1. 1 Create a Zapier account at https://zapier.com/sign-up (if you don't have one)
  2. 2 Install CLI: npm install -g zapier-platform-cli
  3. 3 Run: zapier-platform login
  4. 4 Enter your Zapier email and password when prompted
  5. 5 For SSO users: Generate deploy key from developer account, then run: zapier-platform login --sso

Verify Setup

zapier-platform integrations

Success: Lists integrations you have access to (may be empty if no integrations created yet)

Security & Access

Access Scope

Full access to create, modify, and manage Zapier integrations in your account. Can deploy code, set environment variables, migrate users, and access execution logs.

  • The deploy key in ~/.zapierrc grants full access to manage your integrations - protect it like a password
  • Environment variables are accessible at runtime - never commit sensitive values to source control
  • Your integration code runs with the permissions granted by user authentication - be transparent about data access
  • When using ZAPIER_DEPLOY_KEY in CI/CD, encrypt it using your CI provider's secrets management
  • Deployed code is executed on Zapier's infrastructure and has access to user data based on their auth

Limitations

  • Integrations must be compatible with Node.js v22 runtime
  • Build artifacts must be under 50MB
  • Cannot delete versions with active users or Zaps
  • Migration requires non-breaking changes only
  • Deprecation requires 3+ week notice to users

Get This Skill

Quick Reference

Type
CLI
Auth
CLI Authentication
Setup
Easy Setup
Tools Required
Bash
CLI Dependencies
zapier-platform-cli

Documentation

Have Feedback?

Help us improve this skill by sharing your ideas and suggestions.

Request Improvements