Skip to main content

​
What are Components?

Components are Node.js modules that run on Pipedream’s serverless infrastructure. They can use Pipedream managed auth for + apps (for both OAuth and key-based APIs) and use most npm packages with no npm install or package.json required. Components are most commonly used as the building blocks of Pipedream workflows, but they can also be used like typical serverless functions. You can explore curated components for popular apps in Pipedream’s Marketplace and GitHub repo or you can author and share your own.
Our TypeScript component API is in beta. If you’re interested in developing TypeScript components and providing feedback, see our TypeScript docs.

​
Component Types

Pipedream supports two types of components — sources and actions.

​
Sources

Sources must be instantiated and they run as independent resources on Pipedream. They are commonly used as workflow triggers (but can also be used as standalone serverless functions). Capabilities
  • Accept user input on deploy via props
  • Trigger on HTTP requests, timers, cron schedules, or manually
  • Emit events that can be inspected, trigger Pipedream workflows and that can be consumed in your own app via API
  • Store and retrieve state using the built-in key-value store
  • Use any of Pipedream’s built-in deduping strategies
  • Deploy via Pipedream’s UI, CLI or API
Example The New Files (Instant) source for Google Drive is a prebuilt component in Pipedream’s registry that can be deployed in seconds and emits an event every time a new file is added to the user’s Google Drive, and can also be configured to watch for changes to a specific folder within that drive. Each new event that is emitted can be used to trigger a workflow.

​
Actions

Actions are components that may be used as steps in a workflow. Unlike sources, actions cannot run independently (outside of a workflow). Capabilities
  • Accept user input via props
  • May return JSON serializable data
Example The Add Single Row action for Google Sheets is a prebuilt component in Pipedream’s registry that can be added to a workflow and configured in seconds. Users can configure it in seconds and send workflow data to Google Sheets without having to learn the Google Sheets API.

​
Using Components

Components may be instantiated or added to workflows via Pipedream’s UI.
  • Sources may be instantiated and consumed via UI, CLI or API
  • Actions may be added to workflows

​
Using Private Actions

Private action components published from the CLI or from a Node.js Code Step are available for use across your workflows. To use a published action, add a new step to your workflow and click My Actions. Your privately published action components will appear in this list.