Getting started overview
Pipedream is a platform designed for building event-driven integrations and serverless workflows. It allows developers to connect APIs, orchestrate data flows, and deploy custom code functions without managing server infrastructure. The platform supports a low-code/no-code interface for common tasks while providing full code execution capabilities for complex logic.
This guide focuses on the foundational steps required to get started with Pipedream:
- Account creation and initial setup.
- Locating and understanding API keys and credentials.
- Executing your first workflow or serverless function.
- Identifying common next steps for development.
- Troubleshooting initial configuration issues.
Pipedream's architecture is centered around workflows triggered by events, such as HTTP requests (webhooks), scheduled jobs, or events from integrated applications. Each workflow comprises a series of steps, which can include pre-built actions, custom Node.js or Python code, and data transformations. The platform abstracts away many operational concerns, such as webhook receipt, retries, and error handling, allowing developers to concentrate on business logic (Pipedream event source documentation).
To follow this guide, you will need a web browser and a basic understanding of API concepts. No prior Pipedream experience is assumed.
Create an account and get keys
To begin using Pipedream, the first step is to create an account. Pipedream offers a free tier with monthly invocation limits, which is suitable for initial exploration and development.
Account registration
- Navigate to the Pipedream homepage.
- Click on the "Sign Up Free" or similar button.
- You will typically be prompted to sign up using your Google account or an email address. Choose your preferred method and follow the on-screen instructions to complete the registration process.
- After successful registration, you will be redirected to your Pipedream dashboard.
API key management
Pipedream uses API keys for programmatic access to its platform API and for certain integrations. While many workflow steps handle authentication automatically, understanding where to find and manage your API keys is crucial for advanced use cases, such as deploying workflows via the Pipedream API or integrating with external tools that require Pipedream credentials.
- From your Pipedream dashboard, click on your profile avatar in the top right corner.
- Select "Settings" from the dropdown menu.
- Navigate to the "API Keys" section.
- Here, you can generate new API keys, manage existing ones, and view their permissions. It is a best practice to create separate API keys for different applications or environments to enhance security and simplify key rotation (Pipedream API authentication guide).
- When generating a new key, be sure to copy it immediately, as it may not be retrievable after you navigate away from the page. Treat API keys as sensitive credentials.
Connected accounts
Pipedream workflows often interact with external services (e.g., Stripe, Twilio, Google Sheets). For these integrations, Pipedream uses "Connected Accounts." These accounts store OAuth tokens or API keys securely, allowing your workflows to authenticate with third-party APIs without exposing credentials directly in your code.
- In the Pipedream dashboard, go to "Connections" from the left navigation pane.
- Click "New Connection" and search for the service you wish to connect (e.g., "Stripe").
- Follow the prompts to authorize Pipedream to access your account for that service. This usually involves an OAuth flow or entering an API key directly.
- Once connected, this account can be selected in various workflow steps that interact with the corresponding service.
Your first request
A common first step in Pipedream is to create a simple HTTP webhook-triggered workflow. This demonstrates how Pipedream receives events and executes code.
Create a new workflow
- From your Pipedream dashboard, click the "New Workflow" button.
- Pipedream will prompt you to select an event source. Choose "HTTP / Webhook" and then "New HTTP Request."
- A unique URL for your webhook will be generated. Copy this URL. This is the endpoint where you will send your first request.
- The initial step of the workflow will be an "HTTP Request" trigger.
Add a code step
Now, let's add a custom code step to process the incoming webhook data.
- Click the "+" button below the HTTP trigger step.
- Select "Run Node.js code" or "Run Python code" based on your preference.
- Replace the default code with a simple script to log the incoming event body.
Node.js Example:
export default async ({ event, steps }) => {
console.log("Received webhook event:", event.body);
return { success: true, receivedBody: event.body };
}
Python Example:
def handler(pd):
print("Received webhook event:", pd.steps["trigger"]["event"]["body"])
return {"success": True, "receivedBody": pd.steps["trigger"]["event"]["body"]}
In these examples, event.body (Node.js) or pd.steps["trigger"]["event"]["body"] (Python) accesses the payload sent to the webhook. The function returns a response that Pipedream can then send back to the originating requestor.
Test the workflow
- Save your workflow by clicking the "Deploy" button in the top right.
- Open a new terminal window or use a tool like Postman or Insomnia.
- Send an HTTP POST request to the webhook URL you copied earlier. Include a JSON body in your request.
Example cURL request:
curl -X POST \
-H "Content-Type: application/json" \
-d '{"message": "Hello from apispine!"}' \
YOUR_WEBHOOK_URL
Replace YOUR_WEBHOOK_URL with the actual URL from your Pipedream workflow.
- Return to your Pipedream workflow. You should see a new event appear in the "Inspector" tab on the left. Expand the event to see the details, including the data logged by your custom code step. The response from your
returnstatement will also be visible.
Pipedream Getting Started Quick Reference
| Step | What to Do | Where (Pipedream UI) |
|---|---|---|
| 1. Account Setup | Sign up for a free Pipedream account. | Pipedream Homepage > Sign Up |
| 2. Get API Keys | Generate Pipedream API keys for programmatic access. | Profile Avatar > Settings > API Keys |
| 3. Connect Accounts | Authorize Pipedream to access third-party services. | Left Nav > Connections > New Connection |
| 4. Create Workflow | Start a new workflow with an HTTP webhook trigger. | Dashboard > New Workflow > HTTP / Webhook |
| 5. Add Code Step | Insert a Node.js or Python code step to process data. | Workflow Editor > "+" > Run Node.js / Python code |
| 6. Deploy & Test | Save your workflow and send a POST request to its URL. | Workflow Editor > Deploy button; then use cURL/Postman |
Common next steps
After successfully sending your first request, consider these common next steps to expand your Pipedream usage:
- Explore built-in actions: Pipedream offers a library of thousands of pre-built actions for popular services like Stripe Payments, Salesforce APIs, and Google Workspace APIs. These actions simplify common tasks like sending emails, updating databases, or posting to Slack without writing custom code (Pipedream Integrations list).
- Scheduled workflows: Instead of immediate triggers, create workflows that run at specific intervals using cron-based schedules (Pipedream scheduled triggers).
- Error handling and retries: Configure error handling within your workflows to manage failures gracefully. Pipedream automatically retries steps by default in many scenarios.
- Environment variables: Store sensitive information (like API keys) and configuration values as environment variables within your Pipedream account to keep them out of your code and manage different environments (development, production) (Pipedream environment variable documentation).
- Data stores: Utilize Pipedream's data stores to persist information between workflow invocations, enabling stateful workflows (Pipedream data store guide).
- Custom components: For highly reusable logic or integrations with niche APIs, consider building and sharing custom components.
Troubleshooting the first call
If your first request does not immediately appear in the Pipedream inspector or the workflow fails, consider these troubleshooting steps:
- Check webhook URL: Ensure the webhook URL in your
curlcommand or API client exactly matches the URL provided by Pipedream. Even minor typos can prevent the event from being received. - Request method: Verify that you are sending a POST request. While Pipedream webhooks can handle other methods, the default setup often expects POST.
- Content-Type header: For JSON payloads, ensure the
Content-Type: application/jsonheader is set correctly in your request. Missing or incorrect headers can lead to parsing issues (MDN Content-Type header documentation). - Workflow deployment status: Confirm that your Pipedream workflow is deployed. If it's in a draft state, it will not process incoming events. The "Deploy" button should be greyed out if deployed.
- Pipedream inspector: The "Inspector" tab in your workflow provides detailed logs for each event. Check the event details, step logs, and any error messages that might illuminate the issue.
- Network connectivity: Ensure that the environment from which you are sending the request has outbound access to the internet and can reach Pipedream's servers.
- Firewalls/proxies: If you are within a corporate network, firewalls or proxy servers might be blocking outbound requests. Consult with your network administrator if this is suspected.
- Rate limits: While unlikely for a first request, be aware of Pipedream's free tier rate limits. If you are sending a large volume of requests, you might encounter throttling.