Pipedream Documentation
website·Indexed 41 days ago
https://pipedream.com/docsDeveloper platform for connecting APIs and automating workflows. Includes documentation for Pipedream Connect, a toolkit for adding integrations to apps and AI agents, the Pipedream CLI, and guides for developing custom components using Node.js and TypeScript.
What's inside Pipedream
- The Parallel operator is a multi-path branching block that allows a workflow to execute multiple execution branches simultaneously. Unlike Switch or If/Else operators, the order of defined rules does not affect execution; Pipedream will execute all branches whose filtering rules match the current event. It consists of a start phase (where branching occurs) and an end phase (where branches merge back into the parent flow).
Overview of Pipedream File Stash
File Stash is a storage system that allows files downloaded or created in the/tmpdirectory during a Pipedream execution to be synced and accessed outside of the Pipedream environment. When enabled, files are assigned presigned URLs that remain valid for 30 minutes, allowing anyone with the link to download the file directly.Overview of Pipedream Virtual Private Clouds (VPCs)
Pipedream VPCs allow workflows to run in dedicated, isolated networks with static outbound egress IP addresses unique to your workspace. This enables developers to whitelist Pipedream workflows in external firewalls or databases, ensuring requests originate from a known, consistent IP address. VPCs are available on the Business plan.Overview of Pipedream File Stores
File Stores provide a project-scoped filesystem for long-term cloud storage. Unlike the/tmpdirectory, which is ephemeral and cleared between executions, File Stores persist data across workflow runs. All workflows within the same Project share access to the same File Store; workflows outside the project cannot access it.Overview of Pipedream Data Stores
Data stores are Pipedream’s built-in key-value stores used for storing and retrieving JSON-serializable data across workflow executions. They are useful for caching, rate limiting, counting/summing values over time, and sharing state across different services by connecting multiple workflows to the same data store. Data is Brotli-compressed to minimize storage usage.Overview of Pipedream Connect
Pipedream Connect is a developer toolkit that allows developers to integrate thousands of third-party APIs into their own applications or AI agents. It provides code-level control over integrations while Pipedream handles the underlying complexity of the integration layer. Key capabilities include managed authentication, the ability to make requests on behalf of end users, and access to a registry of pre-built tools and triggers.Overview of Pipedream Custom Tools
Custom tools are Node.js modules developed using the Pipedream Components API and published to a Pipedream workspace. Once published, they are available via Connect APIs (list, retrieve, and run endpoints) alongside public actions. Note that publishing custom tools requires a Pipedream Business plan. Currently, only actions are supported as custom tools; support for custom sources (triggers) is pending.Overview of Pipedream Workflows
Pipedream Workflows are serverless sequences of steps triggered by events (such as HTTP requests or new rows in a Google Sheet). They allow for the integration of apps, data, and APIs without managing infrastructure. Workflows execute linearly in the order steps appear and can be composed of triggers, pre-built actions, or custom code in Node.js, Python, Golang, or Bash.Overview of Pipedream GitHub Sync
GitHub Sync allows Pipedream to serialize workflows into YAML format and synchronize them with a GitHub repository. This enables bi-directional sync, version control via commit/merge history, the use of development branches, and the ability to organize workflows into projects with nested folders. Users can edit workflows directly in Pipedream or use a local editor (like VSCode) and synchronize changes via GitHub.Overview of Pipedream MCP Servers
Pipedream provides a dedicated Model Context Protocol (MCP) server that allows AI assistants (such as Claude or ChatGPT) to securely interact with over 10,000 pre-built tools across thousands of integrated APIs. The system is powered by Pipedream Connect and handles OAuth and secure credential storage, ensuring that user credentials are encrypted at rest and never exposed directly to AI models.Overview of Pipedream Connected Accounts
Connected Accounts allow you to link third-party service credentials to Pipedream. Once connected, these credentials can be used across workflow steps to make authenticated API requests. Pipedream supports two primary integration types:
- OAuth: Pipedream manages the OAuth flow, storing refresh tokens and automatically generating access tokens.
- Key-based: For services using API keys or long-lived tokens, you manually provide the key in the Pipedream UI.
If you prefer to use an external secrets store or database, you can pass credentials at runtime instead of using the UI.
Overview of Pipedream Components
Components are Node.js modules running on Pipedream's serverless infrastructure. They allow developers to create workflow triggers (Sources) and workflow steps (Actions). Key capabilities include:
- Triggering code via HTTP, timers, cron, or manually.
- Accepting user input during deployment via CLI, API, or UI.
- Connecting to apps using Pipedream managed authentication.
- Using npm packages without requiring a
package.jsonornpm install. - Managing state via a built-in key-value store.