Skip to content

Commit b3c9a4a

Browse files
Not ready to merge
1 parent c67dc17 commit b3c9a4a

File tree

6 files changed

+137
-70
lines changed

6 files changed

+137
-70
lines changed

docs-v2/pages/_meta.tsx

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
11
export default {
2-
"index": "What is Pipedream?",
2+
"index": "Introduction",
33
"workspaces": "Workspaces",
44
"projects": "Projects",
5-
"connect": "Connect",
6-
"workflows": "Workflows",
5+
"--connect": {
6+
type: "separator",
7+
title: "Connect",
8+
},
9+
"connect": {
10+
title: "Overview",
11+
// display: "children",
12+
},
13+
"--workflows": {
14+
type: "separator",
15+
title: "Workflows",
16+
},
17+
"workflows": {
18+
title: "Workflows",
19+
// display: "children",
20+
},
21+
"--platform": {
22+
type: "separator",
23+
title: "Platform",
24+
},
725
"apps": "Apps",
826
"components": "Components",
927
"rest-api": "REST API",

docs-v2/pages/connect/_meta.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export default {
2-
"index": "Overview",
2+
"index": "Pipedream Connect",
33
"use-cases": "Use Cases",
44
"managed-auth": "Managed Auth",
55
"components": "Tool Use",

docs-v2/pages/index.mdx

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@ import VideoPlayer from "@/components/VideoPlayer";
22

33
# Introduction to Pipedream
44

5-
Pipedream is the fastest way to automate any process that connects APIs. Build and run workflows with code-level control when you need it, and no code when you don't. Easily add thousands of customer-facing integrations to your app or AI agent in minutes.
5+
Pipedream is the easiest way to automate any process that connects APIs:
6+
7+
- Build and run workflows with code-level control when you need it, and no code when you don't in a [visual builder](/workflows)
8+
- Easily add thousands of customer-facing integrations to your app or AI agent in minutes with [Pipedream Connect](/connect)
69

710
The Pipedream platform includes:
811

912
- A [serverless runtime](/workflows/building-workflows/code/) and [workflow service](/workflows/building-workflows/)
10-
- SDK to handle [customer authentication](/connect/) for {process.env.PUBLIC_APPS}+ APIs
11-
- Source-available pre-built [triggers](/workflows/building-workflows/triggers/) and [actions](/workflows/building-workflows/actions/) for [thousands of integrated apps](https://pipedream.com/explore/)
13+
- SDKs to handle [user authentication](/connect/) for {process.env.PUBLIC_APPS}+ APIs
14+
- Source-available [triggers](/workflows/building-workflows/triggers/) and [actions](/workflows/building-workflows/actions/) for [thousands of integrated apps](https://pipedream.com/explore/)
1215
- One-click [OAuth and key-based authentication](/apps/connected-accounts/) for more than {process.env.PUBLIC_APPS} APIs (use tokens directly in code or with pre-built actions)
1316

1417
<VideoPlayer
@@ -18,32 +21,23 @@ The Pipedream platform includes:
1821

1922
## Getting Started
2023

21-
To get started, [sign up for a free account](https://pipedream.com/auth/signup) (no credit card required) and follow our [quickstart guide](/quickstart/) to create your first workflow.
22-
23-
![build, test,deploy](https://res.cloudinary.com/pipedreamin/image/upload/v1672810771/mjckfcgsoxs4vccutdbj.png)
24-
25-
Once you understand the basics of workflow development, learn how to get more out of Pipedream:
26-
27-
- [Use code in workflows](/workflows/building-workflows/code/)
28-
- [Develop custom actions](/components/contributing/actions-quickstart/)
29-
- [Develop custom triggers](/components/contributing/quickstart/nodejs/sources/)
24+
To get started, [sign up for a free account](https://pipedream.com/auth/signup) (no credit card required) and follow our [quickstart guide](/quickstart/) to create your first workflow or add your first integration.
3025

3126
## Use Cases
3227

33-
Pipedream supports use cases from prototype to production and is trusted by 800k+ developers from startups to Fortune 500 companies:
28+
Pipedream supports use cases from prototype to production and is trusted by more than 1 million developers from startups to Fortune 500 companies:
3429

3530
![logos](https://res.cloudinary.com/pipedreamin/image/upload/v1612919944/homepage/logos_kcbviz.png)
3631

37-
The platform processes billions of events and is built and [priced](https://pipedream.com/pricing/) for use at scale. [Our team](https://pipedream.com/about) has built internet scale applications and managed data pipelines in excess of 10 million events per second (EPS) at startups and high-growth environments like BrightRoll, Yahoo!, Affirm and Instacart.
32+
The platform processes billions of events and is built and [priced](https://pipedream.com/pricing/) for use at scale. [Our team](https://pipedream.com/about) has built internet scale applications and managed data pipelines in excess of 10 million events per second (EPS) at startups and high-growth environments like BrightRoll, Yahoo!, Affirm, and Dropbox.
3833

39-
Our [community](https://pipedream.com/community) uses Pipedream for a wide variety of use cases including:
34+
Our [community](https://pipedream.com/support) uses Pipedream for a wide variety of use cases including:
4035

41-
- Connecting SaaS apps
42-
- General API orchestration and automation
43-
- Database automations ([learn about connecting to resources behind a firewall](/workflows/data-management/databases/))
36+
- AI agents and chatbots
37+
- Workflow builders and SaaS automation
38+
- API orchestration and automation
39+
- Database automations
4440
- Custom notifications and alerting
45-
- Mobile and JAMstack backends
46-
- Rate limiting, request smoothing
4741
- Event queueing and concurrency management
4842
- Webhook inspection and routing
4943
- Prototyping and demos

docs-v2/pages/pricing/index.mdx

Lines changed: 89 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,101 @@ import Callout from '@/components/Callout'
22

33
# Plans and Pricing
44

5-
We believe anyone should be able to run simple, low-volume workflows at no cost. We also hope that you share your [sources](/components/contributing/#sources), [workflows](/workflows/building-workflows/), [actions](/components/contributing/#actions), and other integration components so that other Pipedream users benefit from your work.
5+
We believe anyone should be able to run simple, low-volume workflows at no cost, and we want you to be able to prototype and get to value before having to pay Pipedream any money. We also hope that you share your [sources](/components/contributing/#sources), [workflows](/workflows/building-workflows/), [actions](/components/contributing/#actions), and other integration components so that other Pipedream users benefit from your work.
66

7-
To support these goals, Pipedream offers a generous [free tier](#free-tier), and you can **[request a free trial of our Advanced or Business plan](https://pipedream.com/pricing)**. You can run sources and workflows for free within the limits of the free tier. If you hit these limits, you can upgrade to one of our [paid tiers](#paid-tiers).
7+
To support these goals, Pipedream offers a generous [free plan](#free-plan), free access to Pipedream Connect [while in `development`](/connect/environments), and you can **[request a free trial of our Advanced plan](https://pipedream.com/pricing)**. You can run sources and workflows for free within the limits of the free plan. If you hit these limits, you can upgrade to one of our [paid plans](#paid-plans).
88

99
[Read more about our plans and pricing here](https://pipedream.com/pricing).
1010

11-
## Free Tier
11+
## Free plan
1212

13-
Free Tiers have access to all pre-built actions and triggers, and all of the workflow building capabilites as other paid tiers.
13+
Workspaces on the Free plan have access to many of the Pipedream features including Workflows and Connect. However, the free plan includes several limitations:
1414

15-
But Free account have a [daily limit of free credits](/workflows/limits/#daily-credits-limit) that cannot be exceed. Standard [Pipedream platform limits](/workflows/limits/) apply to Free Accounts as well.
15+
**General:**
16+
- **Daily credit limit**: Free workspaces have a [daily limit of free credits](/workflows/limits/#daily-credits-limit) that cannot be exceeded
17+
- **Support**: Community support only via [our forum](https://pipedream.com/community) and Slack
1618

17-
To lift the daily credit limit and increase the number of workflows and connected accounts [upgrade to a paid tier](https://pipedream.com/pricing).
19+
**Workflows:**
20+
- **Connected accounts**: Limited to 3 different service accounts (like Slack, Google Sheets, GitHub, etc.)
21+
- **Active workflows**: Limited number of active workflows
22+
- **Polling intervals**: Triggers that poll for updates are limited to a lower frequency compared to paid plans
1823

19-
### Free Tier Connected Accounts
24+
**Connect:**
25+
- **Development environment**: Access all the features of Connect while in [development mode](/connect/environments)
2026

21-
Free Tier accounts can connect up to 3 different service accounts like Twitter, Discord, Google Sheets, or any of the thousands of available connections.
27+
To lift the daily credit limit and increase the number of workflows and connected accounts, [upgrade to a paid plan](https://pipedream.com/pricing).
2228

23-
### Free Tier Workflow Limitations
29+
## Paid plans
2430

25-
Free Tier accounts have a [daily credit limit](/workflows/limits/#daily-credits-limit) and have limits on the number of active workflows. Upgrading to a [paid tier](https://pipedream.com/pricing) will increase the number of available active workflows and connected accounts.
31+
[Visit our pricing page](https://pipedream.com/pricing) to learn more about our paid plans.
2632

27-
### Free Tier Polling Interval Limitations
33+
All paid plans vary features based on plan level, but each paid plan option will:
2834

29-
Free Tier account triggers powered by polling are limited to the longest interval. Paid tiers have an option to polling at a substantially higher frequency.
35+
- Remove the daily [credits](#credits) limit for both Workflows and Connect usage
36+
- Increase the number of active workflows available
37+
- Increase the number of connected accounts
38+
- Unlock full Connect production features with higher usage limits
39+
- Provide priority support options
3040

31-
### Free Tier Support options
41+
## Pipedream Connect
3242

33-
Users on the Free Tier have access to community support, on [our forum](https://pipedream.com/community) and Slack. [Visit out Support page](https://pipedream.com/support) for more information.
43+
Pipedream Connect provides SDKs and APIs to let you easily add {process.env.PUBLIC_APPS}+ integrations to your app or AI agent. Connect uses the same credit-based pricing model as Workflows, with some key differences in how credits are consumed.
3444

35-
## Paid Tiers
45+
{/* todo: talk about external users */}
3646

37-
[Visit our pricing page](https://pipedream.com/pricing) to learn more about our paid plans.
47+
### How credits work in Connect
3848

39-
All paid plans vary features based on tier, but each paid plan option will:
49+
Here's how credit usage works in Connect:
4050

41-
- Remove the daily [credits](#credits) limit
42-
- Increase the number of active workflows available
43-
- Increase the number of connected accounts
51+
- **`runAction()`** - Consumes 1 credit per call
52+
- **`makeProxyRequest()`** - Consumes 1 credit per call
53+
- **Deployed triggers** - Consume 1 credit per invocation
54+
- For polling triggers: 1 credit each time the trigger checks for changes (based on your defined polling schedule/interval)
55+
- For webhook triggers: 1 credit each time an event is received
56+
57+
<Callout type="info">
58+
We don't charge credits for API calls that help you manage integrations, such as:
59+
- `getAccounts()` - List connected accounts
60+
- `getApps()` - Get available apps
61+
- `getComponents()` - List components
62+
- `configureComponent()` - Configure component settings
63+
- Other management and configuration endpoints
64+
</Callout>
65+
66+
### Connect credit examples
67+
68+
| Scenario | Credits Used |
69+
| --- | --- |
70+
| Running a Slack "Send Message" action via `runAction()` | 1 credit |
71+
| Making an authenticated API request via `makeProxyRequest()` | 1 credit |
72+
| Polling trigger checking for new GitHub issues every 5 minutes | 1 credit per check (12 per hour) |
73+
| Webhook trigger receiving a Stripe payment event | 1 credit per event |
74+
| Calling `getAccounts()` to list user's connected accounts | 0 credits |
75+
| Configuring a component with `configureComponent()` | 0 credits |
76+
77+
### Connect pricing considerations
78+
79+
- Credits are consumed at the workspace level, shared across both Workflows and Connect usage
80+
- The same [free plan](#free-plan) and [paid plans](#paid-plans) limits apply
81+
- Monitor your Connect usage in your [Billing and Usage Settings](https://pipedream.com/settings/billing)
82+
83+
## Pipedream Workflows
4484

45-
## Definition of Terms
85+
Pipedream Workflows uses a credit-based pricing model where you pay for compute time used during workflow execution.
86+
87+
### Credits and billing
4688

4789
Pipedream uses a number of terms to describe platform metrics and details of our plans. See the definitions of key terms below.
4890

49-
### Credits
91+
#### How credits work for Workflows
5092

5193
Pipedream charges one credit per 30 seconds of compute time at 256MB megabytes of memory (the default) per [workflow segment](/workflows/building-workflows/control-flow/#workflow-segments). Credits are also charged for [dedicated workers](/workflows/building-workflows/settings/#eliminate-cold-starts).
5294

5395
Unlike some other platforms, Pipedream does not charge for usage based on the number of steps. Credits are not charged for workflows during development or testing.
5496

5597
Adding additional memory capacity to workflows will increase credit usage in intervals of 256 megabytes. For example, doubling the memory of a workflow from 256MB to 512MB will double the cost of credits in the same execution time.
5698

57-
#### Scenarios
99+
##### Scenarios
58100

59101
<Callout type="info">
60102
Developing a workflow with test events in the Pipedream workflow builder is free. No credit usage is incurred.
@@ -64,7 +106,7 @@ Developing a workflow with test events in the Pipedream workflow builder is free
64106
If an active workflow isn't executed in a billing period no credit usage is incurred. Pipedream only charges credits for workflow executions.
65107
</Callout>
66108

67-
##### Workflow segments configured to use 256MB memory (default)
109+
###### Workflow segments configured to use 256MB memory (default)
68110

69111
| Scenario | Credits Used |
70112
| --- | --- |
@@ -75,7 +117,7 @@ If an active workflow isn't executed in a billing period no credit usage is incu
75117
| Workflow with a branch - 3 seconds before the branch- 15 seconds within the executed branch | 2 credits |
76118
| Workflow with a branch - 3 seconds before the branch, 15 seconds within the executed branch, 3 seconds after the branch in the parent flow | 3 credits |
77119

78-
##### Workflow segments configured to use 1GB memory
120+
###### Workflow segments configured to use 1GB memory
79121

80122
| Scenario | Credits Used |
81123
| --- | --- |
@@ -86,7 +128,7 @@ If an active workflow isn't executed in a billing period no credit usage is incu
86128
| Workflow with a branch - 3 seconds before the branch- 15 seconds within the executed branch | 8 credits |
87129
| Workflow with a branch - 3 seconds before the branch, 15 seconds within the executed branch, 3 seconds after the branch in the parent flow | 24 credits |
88130

89-
#### Source Credit Usage
131+
##### Source credit usage
90132

91133
When an [event source](/workflows/building-workflows/triggers/) triggers a workflow, **the source execution is included for free.** This includes workspaces on the [Free Tier](/pricing/#free-tier).
92134

@@ -118,50 +160,55 @@ A custom source that finished under 30 seconds per execution
118160
This would result in **1 credit** per execution because the initial free credit only applies to Pipedream Public Registry sources attached to at least one workflow.
119161
</Callout>
120162

121-
### Billing Period
122-
123-
Many of the usage statistics for paid users are tied to a **billing period**. Your billing period starts when you sign up for a paid plan, and recurs roughly once a month for the duration of your subscription.
124-
125-
For example, if you sign up on Jan 1st, your first billing period will last one month, ending around Feb 1st, at which point you'll start a new billing period.
126-
127-
Your invoices are tied to your billing period. [Read more about invoicing / billing here](/pricing/faq/#when-am-i-billed-for-paid-plans).
128163

129-
### Included Credits
164+
#### Included credits
130165

131166
When you sign up for a paid plan, you pay a platform fee at the start of each [billing period](#billing-period). This minimum monthly charge grants you a base of included credits that you can use for the rest of your billing period (see your [Billing and Usage Settings](https://pipedream.com/settings/billing) for your exact quota). If you have been granted any additional credit increases by Pipedream, that is added to the included credits.
132167

133-
### Additional Credits
168+
#### Additional credits
134169

135170
Any credits you run over your [included credit](/workflows/limits/#daily-credits-limit) are called **additional credits**. This usage is added to the invoice for your next [billing period](#billing-period), according to the [invoicing cycle described here](/pricing/faq/#when-am-i-billed-for-paid-plans).
136171

137-
### Data Store Keys
172+
#### Data store keys
138173

139174
A Data Store key represents a single record in a Data Store.
140175

141176
In the example below, there are two records in the Data Store, and therefore there are two keys total.
142177

143178
![Example of a Data Store with two keys](https://res.cloudinary.com/pipedreamin/image/upload/v1673537163/docs/CleanShot_2023-01-12_at_10.25.25_z6yg8t.png)
144179

145-
## Managing my plan
180+
## Managing your plan
146181

147182
To cancel, upgrade or downgrade your plan, open the [pricing page](https://pipedream.com/pricing).
148183

149184
To update your billing details, such as your VAT number, email address, etc. use the **Manage Billing Information** button in your [workspace billing settings](https://pipedream.com/settings/billing) to change your plan. Within this portal you can cancel, upgrade or downgrade your plan at any time.
150185

151-
### Upgrading behavior
186+
### Billing period
187+
188+
Many of the usage statistics for paid users are tied to a **billing period**. Your billing period starts when you sign up for a paid plan, and recurs roughly once a month for the duration of your subscription.
189+
190+
For example, if you sign up on Jan 1st, your first billing period will last one month, ending around Feb 1st, at which point you'll start a new billing period.
191+
192+
Your invoices are tied to your billing period. [Read more about invoicing / billing here](/pricing/faq/#when-am-i-billed-for-paid-plans).
193+
194+
### Upgrading
152195

153-
Upgrading your subscription instantly activates the features available to your workspace. For example, if you upgrade your workspace from Free to Basic, that workspace will be able to activate more workflows and connected accounts.
196+
Upgrading your subscription instantly activates the features available to your workspace. For example, if you upgrade your workspace from Free to Basic, that workspace will immediately be able to activate more workflows and connected accounts.
154197

155-
### Downgrading behavior
198+
### Downgrading
156199

157-
Downgrades will apply at the end of your billing cycle, and any workflows that use features outside of the new billing plan will be automatically disabled.
200+
Downgrades will apply at the end of your billing cycle, and any workflows or integrations that use features outside of the new billing plan will be automatically disabled.
158201

159202
For example, if your workspace downgrades from Advanced to Basic and a workflow uses an Advanced feature such as [auto-retries](/workflows/building-workflows/settings/#auto-retry-errors), then this workflow will be disabled because the workspace plan no longer qualifies for that feature.
160203

161204
Additionally, resource limits such as the number of active workflows and connected accounts will also be enforced at this same time.
162205

163-
### Cancellation behavior
206+
### Cancelling your plan
164207

165208
To cancel your plan, open the [pricing page](https://pipedream.com/pricing) and click **Cancel** beneath your current plan.
166209

167210
Cancelling your subscription will apply at the end of your current billing period. Workflows, connected accounts and sources will be deactivated from newest to oldest until the Free limits have been reached.
211+
212+
## Detailed pricing information
213+
214+
Refere to our [pricing page](https://pipedream.com/pricing) for detailed pricing information.

docs-v2/theme.config.tsx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,16 @@ const config: DocsThemeConfig = {
6161
search: {
6262
component: DocSearch,
6363
},
64+
// We can add banners to the docs for product announcements
65+
// banner: {
66+
// key: "announcement-key", // Used for dismissible state in localStorage
67+
// dismissible: true, // Makes the banner dismissible
68+
// content: (
69+
// <a href="https://pipedream.com/connect/demo/" target="_blank" rel="noreferrer">
70+
// Check out the new Pipedream Connect SDK Playground →
71+
// </a>
72+
// ),
73+
// },
6474
};
6575

6676
export default config;

0 commit comments

Comments
 (0)