zapier-convert

Convert a visual builder integration

$ zapier convert [integration_id] [path/to/directory]

$ zapier convert [integration_id] [path/to/directory] [[-v|--version]]=[version]

$ zapier convert --debug

zapier-convert [PATH] [-o, --output DIR] [-y, --yes]

-o, --output DIR
    Directory to output the converted v3 app (default: ./zapier-conversion-tmp)

-y, --yes
    Automatically answer 'yes' to all confirmation prompts

-h, --help
    Display help message and exit

The zapier-convert command is a utility in the Zapier Platform CLI designed to automate the migration of Zapier integration apps from version 2 to the newer version 3 format.

Version 3 introduces enhancements like improved async support, better resource handling, updated authentication flows, and more flexible component definitions. zapier-convert scans the input app's source code, identifies triggers, actions, searches, and resources, then generates equivalent v3 structures while preserving functionality.

It handles common migration tasks automatically, such as converting synchronous operations to async patterns and updating deprecated APIs. However, complex custom code may require manual review and adjustments post-conversion.

Primarily used by Zapier developers maintaining or updating integrations, it streamlines the upgrade process, reducing manual refactoring time. The tool outputs a new app directory, allowing side-by-side comparison with the original.

Requires Zapier CLI installed via npm. Converts only v2 to v3 (no reverse). Post-conversion manual fixes often needed for custom logic. Not for production apps without validation.

Run npm install -g @zapier/cli or use npx @zapier/cli convert ...

zapier-convert ./my-app-v2 -o ./my-app-v3
Converts my-app-v2 to v3 in specified output dir.

Added in Zapier Platform CLI v10.x (2023) to support v3 app migration amid Platform UI updates and async feature rollout.

zapier(1), zapier-validate(1), zapier-push(1)