Registry Components Structure
All Pipedream registry components live in this GitHub repo under thecomponents
directory.
Every integrated app on Pipedream has a corresponding directory that defines the actions and sources available for that app. Below is a simplified version of the Airtable app directory within the registry:
π airtableββπ README.md
ββπ airtable.app.mjs
ββπ package.json
ββπ actions
ββββπ get-record
ββββββπ get-record.mjs
ββπ node_modules
ββββπ β¦here be dragons
ββπ sources
ββββπ new-records
ββββββπ new-records.mjs
In the example above, the
components/airtable/actions/get-record/get-record.mjs
component is published as the Get Record action under the Airtable app within the workflow builder in Pipedream.
The repository is missing the app directory Iβd like to add components forYou can request to have new apps integrated into Pipedream.Once the Pipedream team integrates the app, weβll create a directory for the app in the
components
directory of the GitHub repo.Contribution Process
Anyone from the community can build sources and actions for integrated apps. To submit new components or update existing components:- Fork the public Pipedream Registry Github Repository.
- Create a new component within the corresponding appβs directory within the
components
directory (if applicable). - Create a PR for the Pipedream team to review.
- Address any feedback provided by Pipedream based on the best practice Component Guidelines & Patterns.
- Once the review is complete and approved, Pipedream will merge the PR to the
master
branch - The component will be available for use within workflows for all Pipedream developers! π
Component Development Discussion
Join the discussion with other Pipedream component developers at the #contribute channel in Slack or on Discourse.Reference Components
The following components are references for developing sources and actions for Pipedreamβs registry.Reference Sources
Name | App | Type |
---|---|---|
New Card | Trello | Webhook |
New or Modified Files | Google Drive | Webhook + Polling |
New Submission | Jotform | Webhook (with no unique hook ID) |
Reference Actions
Name | App |
---|---|
Add Multiple Rows | Google Sheets |
Send Message | Discord |
Append Text | Google Docs |
GET request | HTTP |