Skip to content

Commit 6bdfb2c

Browse files
Docs tweaks
1 parent 7cb7338 commit 6bdfb2c

File tree

4 files changed

+13
-15
lines changed

4 files changed

+13
-15
lines changed

docs-v2/pages/connect/api.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,8 @@ export default function Home() {
8585
const pd = createFrontendClient()
8686
function connectAccount() {
8787
pd.connectAccount({
88-
app: appSlug,
88+
app: appSlug, // Pass the app name slug of the app you want to integrate
89+
oauthAppId: appId, // For OAuth apps, pass the OAuth app ID; omit this param to use Pipedream's OAuth client or for key-based apps
8990
token, // The token you received from your server above
9091
onSuccess: ({ id: accountId }) => {
9192
console.log(`Account successfully connected: ${accountId}`)
@@ -95,7 +96,7 @@ export default function Home() {
9596

9697
return (
9798
<main>
98-
<button style={{ all: "revert" }} onClick={connectAccount}>Connect your account</button>
99+
<button onClick={connectAccount}>Connect your account</button>
99100
</main>
100101
)
101102
}
@@ -107,7 +108,7 @@ When you use the Connect API, you'll pass an `external_user_id` parameter when i
107108

108109
Pipedream associates this ID with user accounts, so you can retrieve credentials for a specific user, and invoke workflows on their behalf.
109110

110-
External IDs are limited to 250 characters.
111+
External User IDs are limited to 250 characters.
111112

112113
## Rate limits
113114

docs-v2/pages/connect/index.mdx

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,13 @@ Pipedream Connect lets you build any API integration into your product in minute
3535

3636
Watch [the demo](https://www.youtube.com/embed/xhUagMsogkQ) or visit [the quickstart](/connect/quickstart) to build your first integration.
3737

38-
## App configuration
38+
## App configuration for OAuth apps
3939

40-
To add a new integration:
40+
Pipedream has more than {process.env.PUBLIC_APPS} apps available for you to integrate via Connect. Getting started is easy — just follow the [quickstart](/connect/quickstart) to get up and running.
4141

42-
1. Open your project
43-
2. Click the **Connect** tab
44-
3. In the **Apps** section, add a new app.
45-
46-
You can add any of Pipedream's [supported apps](https://pipedream.com/apps) to your project, or [request a new app here](https://pipedream.com/support).
42+
By default, apps that use OAuth to authenticate will use Pipedream's official OAuth client. To deploy your integrations to production, you'll need to configure your own OAuth client. Read more about OAuth clients in Pipedream [here](/connected-accounts/oauth-clients).
4743

48-
When you add an app that uses OAuth to authenticate, you can choose to use either Pipedream's OAuth client (for testing) or [your own OAuth client](/connected-accounts/oauth-clients). If you'd like to use Pipedream OAuth clients in production, please reach out at `[email protected]` or in our [Slack community](https://pipedream.com/support).
44+
[Let us know](https://pipedream.com/support) if the app you're looking for isn't listed [here](https://pipedream.com/apps).
4945

5046
## Users
5147

docs-v2/pages/connect/oauth-clients.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ There are two types of apps in Pipedream:
1212
1. **Key-based**: These apps require static credentials, like API keys. Pipedream stores these credentials securely and exposes them via API.
1313
2. **OAuth**: These apps require OAuth authorization. Pipedream manages the OAuth flow for these apps, ensuring you always have a fresh access token for requests.
1414

15-
**OAuth apps require you create your own OAuth client to [deploy to production](/connect/environments):**
15+
**OAuth apps require you create your own OAuth client to [deploy Connect to production](/connect/environments):**
1616

1717
<Callout type="info">
1818
To get started in [development mode](/connect/environments), you can skip these steps. To deploy your app to production, you'll need to [create an OAuth client](#using-a-custom-oauth-client) for the app you're integrating.

docs-v2/pages/connect/quickstart.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ and fill the `.env.local` file with your project and app details:
4949
# Used by `app/server.ts` to authorize requests to the Pipedream API — see below
5050
PIPEDREAM_OAUTH_CLIENT_ID=your_client_id
5151
PIPEDREAM_OAUTH_CLIENT_SECRET=your_client_secret
52+
PIPEDREAM_PROJECT_ENVIRONMENT=development
5253
PIPEDREAM_PROJECT_ID=your_project_id
5354
```
5455

@@ -61,7 +62,7 @@ If you're building your own app, you'll need to provide these values to the envi
6162

6263
### Create a Pipedream OAuth client
6364

64-
Pipedream uses OAuth to authorize requests to the REST API. To create an OAuth application:
65+
Pipedream uses OAuth to authorize requests to the REST API. To create an OAuth client:
6566

6667
1. Visit the [API settings](https://pipedream.com/settings/api) for your workspace.
6768
2. Click the **New OAuth Client** button.
@@ -90,15 +91,15 @@ If you're using a different server / API framework, you'll need to make secure c
9091
Once you have a token, return it to your frontend to start the account connection flow for the user, or redirect them to a Pipedream-hosted URL with [Connect Link](#use-connect-link).
9192

9293
<Callout type="info">
93-
Refer to the API docs for [all the parameters you can pass](/connect/api#create-a-new-token) in the `ConnectTokenCreate` call.
94+
Refer to the API docs for [full set of parameters you can pass](/connect/api#create-a-new-token) in the `ConnectTokenCreate` call.
9495
</Callout>
9596

9697
### Connect a user's account
9798

9899
To connect a third-party account for a user, you have two options:
99100

100101
1. [Use the Pipedream SDK](#use-the-pipedream-sdk-in-your-frontend) in your frontend
101-
2. [Use Connect Link](#use-connect-link) to deliver a hosted URL to your user (see above).
102+
2. [Use Connect Link](#use-connect-link) to deliver a hosted URL to your user
102103

103104
#### Use the Pipedream SDK in your frontend
104105

0 commit comments

Comments
 (0)