The Pipedream SDK v2.x is now available with significant improvements. While v1.x continues to be supported, we recommend upgrading to v2.x for new projects to take advantage of improved TypeScript support, new features, and ongoing updates.

​
Overview

The Pipedream SDK v2.x introduces significant improvements including:
  • Full TypeScript support with comprehensive type definitions
  • Namespaced methods for better organization (e.g., client.actions.run())
  • Improved pagination support for large data sets
  • snake_case parameter naming for consistency with the REST API

​
Migration Resources

For detailed migration instructions and examples, refer to the migration guide:

Detailed Migration Guide

Step-by-step instructions, code examples, and migration strategies for upgrading from v1.x to v2.x

​
Key Breaking Changes from v1.x to v2.x

The migration guide covers these major breaking changes:
  • Client initialization: New PipedreamClient class
  • Method namespacing: Actions, accounts, and other methods are now namespaced
  • Parameter naming: CamelCase parameters converted to snake_case

​
Migration Support

If you encounter issues during migration:
  1. Consult the migration guide for detailed examples
  2. Check the API / SDK documentation for v2.x usage patterns
  3. Join our community for additional support
The migration guide includes options for incremental migration, allowing you to upgrade your codebase gradually rather than all at once.