Skip to content

Commit de4f748

Browse files
Docs updates for Connect (#17148)
* Not ready to merge * Connect pricing * Fixing links * Minor cleanup * Update index.mdx
1 parent feac320 commit de4f748

File tree

15 files changed

+143
-91
lines changed

15 files changed

+143
-91
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: "Integrate APIs",
11+
// display: "children",
12+
},
13+
"--workflows": {
14+
type: "separator",
15+
title: "Workflows",
16+
},
17+
"workflows": {
18+
title: "Build 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/account/billing-settings.mdx

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,40 @@ You'll find information on your usage data (for specific [Pipedream limits](/wor
66

77
## Subscription
88

9-
You can upgrade to [paid plans](https://pipedream.com/pricing) from this section.
10-
119
If you've already upgraded, you'll see an option to **Manage Subscription** here, which directs you to your personal Stripe portal. Here, you can change your payment method, review the details of previous invoices, and more.
1210

1311
## Usage
1412

15-
[Credits](/pricing/#credits) are Pipedream's billable unit, and users on the [free tier](/pricing/#free-tier) are limited on the number of daily free credits allocated. The **Usage** section displays a chart of the daily credits across a historical range of time to provide insight into your usage patterns.
13+
[Credits](/pricing/#credits-and-billing) are Pipedream's billable unit, and users on the [free plan](/pricing/#free-plan) are limited on the number of daily free credits allocated. The **Usage** section displays a chart of the daily credits across a historical range of time to provide insight into your usage patterns.
14+
15+
<Callout type="warning">
16+
Credit usage from [Connect](/connect) is not yet reflected in this section.
17+
</Callout>
1618

1719
Hover over a specific column in the chart to see the number of credits run for that specific day:
1820

1921
![Daily credits tooltip](/images/account/daily-invocations-tooltip.png)
2022

21-
_Click_ on a specific column to see credits for that day, broken out by workflow / source:
23+
Click on a specific column to see credits for that day, broken out by workflow / source:
2224

2325
![Credits broken out by workflow / source](/images/account/usage-by-resource.png)
2426

2527
Users on the free tier will see the last 30 days of usage in this chart. Users on [paid plans](https://pipedream.com/pricing) will see the cumulative usage tied to their current billing period.
2628

2729
## Compute Budget
2830

29-
Control the maximum number of compute credits permitted on your account with an _Credit Budget_.
31+
Control the maximum number of credits permitted on your account with a **Credit Budget**.
3032

31-
This will restrict your account-wide usage to the specified number of [credits](/pricing/#credits) on a monthly or daily basis. The compute budget does not apply to credits incurred by [dedicated workers](/workflows/building-workflows/settings/#eliminate-cold-starts).
33+
This will restrict your workspace-wide usage to the specified number of [credits](/pricing/#credits-and-billing) on a monthly or daily basis. The compute budget does not apply to credits incurred by [dedicated workers](/workflows/building-workflows/settings/#eliminate-cold-starts) or Pipedream Connect.
3234

33-
To enable this feature, _click_ on the toggle and define your maximum number of credits in the period.
35+
To enable this feature, click on the toggle and define your maximum number of credits in the period.
3436

3537
<Callout type="info">
36-
Due to how credits are accrued, there may be cases where your credit usage may _slightly_ go over the cap.
38+
Due to how credits are accrued, there may be cases where your credit usage may go slightly over the cap.
3739

3840
In an example scenario, with a cap set at 20 credits and a long-running workflow that uses 10 credits per run, it's possible that two concurrent events trigger the workflow, and the cap won't apply until after the concurrent events are processed.
3941
</Callout>
4042

4143
## Limits
4244

43-
For users on the [Free tier](/pricing/#free-tier), this section displays your usage towards your [credits quota](/workflows/limits/#daily-credits-limit) for the current UTC day.
45+
For users on the [Free tier](/pricing/#free-plan), this section displays your usage towards your [credits quota](/workflows/limits/#daily-credits-limit) for the current UTC day.

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/connect/api-proxy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ import { createBackendClient } from "@pipedream/sdk/server";
7979

8080
const pd = createBackendClient({
8181
environment: {development | production},
82-
projectId: {your_pipedream_project_i_d},
82+
projectId: {your_pipedream_project_id},
8383
credentials: {
8484
clientId: {your_oauth_client_id},
8585
clientSecret: {your_oauth_client_secret}

docs-v2/pages/connect/api.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -235,10 +235,6 @@ curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/actions/run
235235

236236
## API Reference
237237

238-
### Invoke workflows
239-
240-
You can use the SDK to [invoke workflows on behalf of any end user](/connect/workflows/). **Write one workflow, run it for all of your users**.
241-
242238
### Tokens
243239

244240
Your app will initiate the account connection flow for your end users in your frontend. To securely scope connection to a specific end user, on your server, **you retrieve a short-lived token for that user**, and return that token to your frontend.
@@ -3726,3 +3722,9 @@ curl -X PUT \
37263722
]
37273723
}
37283724
```
3725+
3726+
### Workflows
3727+
3728+
#### Invoke workflows
3729+
3730+
You can use the SDK to [invoke workflows on behalf of any end user](/connect/workflows/). **Write one workflow, run it for all of your users**.

docs-v2/pages/connect/mcp/openai.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ const pd = createBackendClient({
101101
// For this example, we'll use Notion
102102
const apps = await pd.getApps({ q: "notion" });
103103
const appSlug = apps.data[0].name_slug; // e.g., "notion",
104-
const appLabel = apps.data[0].name; // e.g., "Notion"
105104

106105
// Get access token for MCP server auth
107106
const accessToken = await pd.rawAccessToken();
@@ -118,7 +117,7 @@ const response = await client.responses.create({
118117
tools: [
119118
{
120119
type: 'mcp',
121-
server_label: appLabel,
120+
server_label: appSlug,
122121
server_url: `https://remote.mcp.pipedream.net`,
123122
headers: {
124123
Authorization: `Bearer ${accessToken}`,

docs-v2/pages/glossary.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ You can restrict access to connected accounts to specific individuals or share w
104104

105105
### Credit
106106

107-
Pipedream charges one credit per 30 seconds of compute time at 256MB megabytes of memory (the default) per workflow execution. Credits are also charged for [dedicated workers](#dedicated-workers). [See the docs](/pricing/#credits) for more details.
107+
Pipedream charges one credit per 30 seconds of compute time at 256MB megabytes of memory (the default) per workflow execution. Credits are also charged for [dedicated workers](#dedicated-workers). [See the docs](/pricing/#credits-and-billing) for more details.
108108

109109
### Custom domain
110110

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+
- [Pipedream Connect](/connect) makes it easy to add thousands of customer-facing integrations to your app or AI agent in minutes
8+
- Our [visual builder](/workflows) lets you build and run complex workflows with code-level control when you need it, and no code when you don't
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

0 commit comments

Comments
 (0)