Skip to content

Commit a024e77

Browse files
First pass (#16705)
* First pass * Fixing refs * Additional changes * Update pnpm-lock.yaml
1 parent 6144407 commit a024e77

File tree

21 files changed

+371
-264
lines changed

21 files changed

+371
-264
lines changed

docs-v2/components/ConnectCodeSnippets.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export function getServerCodeSnippet(externalUserId) {
1313
1414
// This code runs on your server
1515
const pd = createBackendClient({
16-
environment: "development",
16+
environment: "production",
1717
credentials: {
1818
clientId: process.env.PIPEDREAM_CLIENT_ID,
1919
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET,

docs-v2/next.config.mjs

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,12 @@ export default withNextra({
9191
},
9292
{
9393
source: "/quickstart/run-workflow-on-a-schedule/",
94-
destination: "/quickstart/",
94+
destination: "/workflows/quickstart/",
95+
permanent: true,
96+
},
97+
{
98+
source: "/quickstart/",
99+
destination: "/workflows/quickstart/",
95100
permanent: true,
96101
},
97102
{
@@ -476,6 +481,11 @@ export default withNextra({
476481
destination: "/connect/managed-auth/webhooks/",
477482
permanent: true,
478483
},
484+
{
485+
source: "/connect/environments/",
486+
destination: "/connect/managed-auth/environments/",
487+
permanent: true,
488+
},
479489
{
480490
source: "/integrations/connected-accounts/oauth-clients/",
481491
destination: "/integrations/oauth-clients/",

docs-v2/pages/_meta.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
export default {
22
"index": "What is Pipedream?",
3-
"quickstart": "Quickstart",
43
"workspaces": "Workspaces",
54
"projects": "Projects",
65
"connect": "Connect",

docs-v2/pages/connect/_meta.tsx

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,12 @@
11
export default {
2-
"index": {
3-
"title": "Overview",
4-
},
5-
"use-cases": {
6-
"title": "Use cases",
7-
},
8-
"managed-auth": {
9-
"title": "Managed auth",
10-
},
11-
"components": {
12-
"title": "Pre-built tools",
13-
},
14-
"mcp": {
15-
"title": "MCP servers",
16-
},
17-
"api-proxy": {
18-
"title": "API proxy",
19-
},
20-
"workflows": {
21-
"title": "Workflows",
22-
},
23-
"environments": {
24-
"title": "Environments",
25-
},
26-
"api": {
27-
"title": "API & SDK reference",
28-
},
2+
"index": "Overview",
3+
"use-cases": "Use cases",
4+
"managed-auth": "Managed auth",
5+
"components": "Tool calling",
6+
"mcp": "MCP",
7+
"api-proxy": "API proxy",
8+
"workflows": "Workflows",
9+
"api": "API & SDK reference",
2910
"migrating-from-project-keys-to-oauth": {
3011
"display": "hidden",
3112
},

docs-v2/pages/connect/api-proxy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Before getting started with the Connect proxy, make sure you've already gone thr
2727
You can send requests to the Connect proxy using the [Pipedream SDK](/connect/sdk/) with a fetch-style interface, or by making a request to the [REST API](/rest-api/connect/proxy/).
2828

2929
- A [Pipedream OAuth client](/rest-api/auth/#oauth) to make authenticated requests to Pipedream's API
30-
- Connect [environment](/connect/environments/) (ex, `production` or `development`)
30+
- Connect [environment](/connect/managed-auth/environments/) (ex, `production` or `development`)
3131
- The [external user ID](/connect/api/#external-users) for your end user (ex, `abc-123`)
3232
- The [account ID](/connect/api/#accounts) for your end user's connected account (ex, `apn_1234567`)
3333

docs-v2/pages/connect/api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ export default function Home() {
104104

105105
## Environment
106106

107-
Some API endpoints accept an [environment](/connect/environments/) parameter. This lets you specify the environment (`production` or `development`) where resources will live in your project.
107+
Some API endpoints accept an [environment](/connect/managed-auth/environments/) parameter. This lets you specify the environment (`production` or `development`) where resources will live in your project.
108108

109109
Always set the environment when you create the SDK client:
110110

docs-v2/pages/connect/managed-auth/_meta.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ export default {
44
"tokens": "Connect Tokens",
55
"connect-link": "Connect Link",
66
"oauth-clients": "OAuth Clients",
7+
"environments": "Environments",
78
"webhooks": "Webhooks",
8-
"customization": "Customizing the Auth Flow",
9+
"customization": "Project Configuration",
910
} as const

docs-v2/pages/connect/managed-auth/customization.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
import ArcadeEmbed from '@/components/ArcadeEmbed'
22
import Callout from '@/components/Callout'
33

4-
# Customizing the Auth Flow
4+
# Project Configuration
5+
6+
By default, your end users will see a primarly Pipedream branded experience when they connect their account. To customize this screen to highlight your application, you can configure your [app's name](#application-name), [support email](#support-email), and [logo](#logo) in the Pipedream UI.
57

68
<ArcadeEmbed
79
src="https://demo.arcade.software/b3aw8YEPFavVpOrXRvca?embed"
810
title="Pipedream Connect Auth Flow">
911
</ArcadeEmbed>
1012

11-
<Callout type="info">
12-
By default, your end users will see a primarly Pipedream branded experience when they connect their account. To customize this screen to highlight your application, you can configure your [app's name](#application-name), [support email](#support-email), and [logo](#logo) in the Pipedream UI.
13-
</Callout>
14-
1513
## Customizing your application details
1614

1715
Open your project in the Pipedream UI: [https://pipedream.com/projects](https://pipedream.com/projects)

docs-v2/pages/connect/environments.mdx renamed to docs-v2/pages/connect/managed-auth/environments.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@ import Image from 'next/image'
33

44
# Environments
55

6-
Pipedream Connect projects support two environments: `development` and `production`. Connected accounts and credentials stored in `development` remain separate from `production`.
6+
Pipedream Connect projects support two environments: `development` and `production`. Connected accounts and credentials stored in one environment remain separate from the other.
77

88
<Callout type="info">
9-
You can use all of the Connect features in `development` mode **on any plan**. **[Visit the pricing page](https://pipedream.com/pricing?plan=Connect)** to select the right plan when you're ready to ship to production.
9+
You can use all of the Connect features in `development` mode **on any plan**. **[Visit the pricing page](https://pipedream.com/pricing?plan=Connect)** to select the right plan when you're ready to ship your app to production.
1010
</Callout>
1111

1212
## Development mode
1313

14-
Development mode provides access to all Connect features while you're building and testing your integration. It has the following constraints:
14+
Development mode provides access to all Connect features while you're building and testing your integration with the following constraints:
1515

1616
- **Maximum of 10 external users**: The development environment is limited to 10 unique external user IDs. If you exceed this limit, you'll need to [delete some existing users](/connect/managed-auth/users/#deleting-users) before adding new ones.
1717
- **Must be signed in to pipedream.com**: When connecting an account in development mode, you must be signed in to pipedream.com in the same browser where you're connecting your account.
1818
- **Personal testing only**: Development mode is intended for your own accounts during testing and development, not for your real end users.
1919

2020
<Callout type="warning">
21-
The `development` environment is not intended for production use with your customers. When you're ready to launch, you should transition to the `production` environment.
21+
The `development` environment is not intended for production use with your customers. When you're ready to launch, you should transition to `production`.
2222
</Callout>
2323

2424
<br />
@@ -39,7 +39,8 @@ const pd = createBackendClient({
3939
credentials: {
4040
clientId: "your-oauth-client-id",
4141
clientSecret: "your-oauth-client-secret",
42-
}
42+
},
43+
projectId: "proj_xxxxxxx"
4344
});
4445
```
4546

docs-v2/pages/connect/managed-auth/quickstart.mdx

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import Callout from '@/components/Callout'
2-
import { Steps, Tabs } from 'nextra/components'
2+
import { Steps } from 'nextra/components'
33
import Image from 'next/image'
44
import VideoPlayer from "@/components/VideoPlayer"
55
import { GlobalConnectProvider } from '@/components/GlobalConnectProvider'
@@ -27,17 +27,17 @@ Here's how Connect sits in your frontend and backend, and communicates with Pipe
2727

2828
## Getting started
2929

30+
We'll walk through these steps below with an interactive demo that lets you see an execute the code directly in the docs.
31+
3032
<Steps>
3133

3234
### Configure your environment
3335

3436
You'll need to do two things to add Pipedream Connect to your app:
3537

36-
1. [Connect to the Pipedream API from your server](#generate-a-short-lived-token). This lets you make secure calls to the Pipedream API to initiate the account connection flow and retrieve account credentials. If you're running a JavaScript framework like Node.js on your server, you can use the Pipedream SDK.
38+
1. [Connect to the Pipedream API from your server](#generate-a-short-lived-token). This lets you make secure calls to the Pipedream API to initiate the account connection flow and retrieve account credentials.
3739
2. [Add the Pipedream SDK to your frontend](#connect-your-users-account) or redirect your users to [a Pipedream-hosted URL](/connect/connect-link/) to start the account connection flow.
3840

39-
We'll walk through these steps below with an interactive demo that lets you see an execute the code directly in the docs.
40-
4141
If you're building your own app, you'll need to provide these credentials to the environment, or retrieve them from your secrets store:
4242

4343
```bash
@@ -50,26 +50,23 @@ PIPEDREAM_PROJECT_ID=your_project_id
5050

5151
### Create a project in Pipedream
5252

53-
1. Open an existing Pipedream project or create a new one at [pipedream.com/projects](https://pipedream.com/projects).
54-
2. Click the **Settings** tab, then copy your **Project ID**.
53+
1. Open an existing Pipedream project or create a new one at [pipedream.com/projects](https://pipedream.com/projects)
54+
2. Click the **Settings** tab, then copy your **Project ID**
5555

5656
### Create a Pipedream OAuth client
5757

5858
Pipedream uses OAuth to authorize requests to the REST API. To create an OAuth client:
5959

60-
1. Visit the [API settings](https://pipedream.com/settings/api) for your workspace.
61-
2. Click the **New OAuth Client** button.
62-
3. Name your client and click **Create**.
63-
4. Copy the client secret. **It will not be accessible again**. Click **Close**.
64-
5. Copy the client ID from the list.
60+
1. Visit the [API settings](https://pipedream.com/settings/api) for your workspace
61+
2. Create a new OAuth client and note the client ID and secret
6562

6663
You'll need these when configuring the SDK and making API requests.
6764

6865
### Generate a short-lived token
6966

7067
To securely initiate account connections for your users, you'll need to generate a short-lived token for your users and use that in the [account connection flow](#connect-your-users-account). See [the docs on Connect tokens](/connect/tokens/) for a general overview of why we need to create tokens and scope them to end users.
7168

72-
In the code below you can see how we generate a Connect token for an example user, and even **try it yourself**:
69+
Check out the code below **try it yourself**:
7370

7471
<div className="not-prose">
7572
<TokenGenerationDemo />
@@ -83,7 +80,7 @@ Refer to the API docs for [full set of parameters you can pass](/connect/api/#cr
8380

8481
### Connect your user's account
8582

86-
To connect a third-party account for a user, you have two options:
83+
You have two options when connecting an account for your user:
8784

8885
1. [Use the Pipedream SDK](#use-the-pipedream-sdk-in-your-frontend) in your frontend
8986
2. [Use Connect Link](#or-use-connect-link) to deliver a hosted URL to your user
@@ -128,24 +125,16 @@ Check out the [full API docs](/connect/api/#create-token) for all parameters you
128125

129126
Now that your users have connected an account, you can use their auth in one of a few ways:
130127

131-
1. [Retrieve their credentials from the REST API](/connect/api/#accounts) to use in your backend application
132-
2. [Use Pipedream's visual workflow builder](/connect/workflows/) to define complex logic to run on behalf of your users
133-
3. [Embed Pipedream components directly in your app](/connect/components/) to run actions and triggers on their behalf
128+
1. [Expose 10k+ tools](/connect/components/) to your AI app or agent and call them on behalf of your customers
129+
2. [Send custom requests](/connect/proxy/) to any one of the 2500+ APIs using the Connect API proxy
130+
3. [Use Pipedream's visual workflow builder](/connect/workflows/) to define complex logic to run on behalf of your users
131+
4. [Embed Pipedream components directly in your app](/connect/components/) to run actions and triggers on their behalf
134132

135133
### Deploy your app to production
136134

137-
- Test end to end in [development](/connect/environments/)
135+
- Test end to end in [development](/connect/managed-auth/environments/)
138136
- Ship to production!
139137

140138
</Steps>
141139

142-
<div className="mt-8 text-sm text-gray-600 border-t pt-4">
143-
<p className="text-sm">This quickstart showcases the recommended implementation flow:</p>
144-
<ol className="list-decimal pl-5 mt-2 space-y-1 text-sm">
145-
<li>Securely generate a token on your server (keeping credentials private)</li>
146-
<li>Pass the token to your frontend to connect an account</li>
147-
</ol>
148-
<p className="mt-2 text-sm opacity-80">Note: Each time you reload this page, a new unique user ID is generated.</p>
149-
</div>
150-
151140
</GlobalConnectProvider>

0 commit comments

Comments
 (0)