Skip to content

Commit 10ef6b9

Browse files
Updating based on apps UI
1 parent 9f37681 commit 10ef6b9

File tree

2 files changed

+12
-47
lines changed

2 files changed

+12
-47
lines changed

docs-v2/pages/connect/index.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,6 @@ All credentials and tokens are sent to Pipedream securely over HTTPS, and encryp
7373
- **Use secure, session-based auth between your client and server** — authorize all requests from your client to your server using a secure, session-based auth mechanism. Use well-known identity providers with services like [Clerk](https://clerk.com/), [Firebase](https://firebase.google.com/), or [Auth0](https://auth0.com/) to securely generate and validate authentication tokens. The same follows for Pipedream workflows — if you trigger Pipedream workflows from your client or server, validate all requests in the workflow before executing workflow code.
7474
- **Secure your workflows** — See our [standard security practices](/privacy-and-security/best-practices) for recommendations on securing your Pipedream workflows.
7575

76-
## Glossary of terms
77-
78-
- **App**: GitHub, Notion, Slack, Google Sheets, and more. The app is the API you want your users to connect to in your product. See the [full list here](https://pipedream.com/apps).
79-
- **Developer**: This is probably you, the Pipedream customer who's developing an app and wants to use Connect to make API requests on behalf of your end users.
80-
- **End User**: Your customer or user, whose data you want to access on their behalf. End users are identifed via the `external_id` param in the Connect SDK and API.
81-
- **Connected Account**: The account your end user connects. [Read more about connected accounts](/connected-accounts).
82-
- **OAuth Client**: Custom OAuth clients you create in Pipedream. [Read more about OAuth clients](/connected-accounts/oauth-clients).
83-
8476
## Product roadmap for Connect
8577

8678
- Address bugs and feedback during the preview phase

docs-v2/pages/connect/quickstart.mdx

Lines changed: 12 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -28,47 +28,24 @@ And here's the technical flow between your frontend, backend, and Pipedream's AP
2828

2929
<Steps>
3030

31-
### Choose the apps you want to integrate
31+
### Add the apps you want to integrate
32+
33+
1. Open an existing Pipedream project or create a new one at [https://pipedream.com/projects](https://pipedream.com/projects).
34+
2. Click the **Connect** tab, then select **Apps**.
35+
3. From here, you can add any app to your project that you want to integrate with your application.
3236

3337
There are two types of apps in Pipedream:
3438

3539
1. **Key-based**: These apps require static credentials, like API keys. Pipedream stores these credentials securely and exposes them via API.
3640
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.
3741

38-
Connecting Key-based apps with the Pipedream API requires only [the app's name slug](#find-your-apps-name-slug). OAuth apps require you to [create your own OAuth client](#creating-a-custom-oauth-client) and pass the OAuth app ID, as well.
39-
40-
#### Find your app's name slug
41-
42-
Typically, the name slug is the name of the app in lowercase, with spaces replaced by underscores. For example, the name slug for the GitHub app is `github`. The name slug for Google Sheets is `google_sheets`.
43-
44-
To find the name slug for an app:
45-
46-
1. Visit [https://pipedream.com/apps](https://pipedream.com/apps)
47-
2. Search and select the app you want to integrate
48-
3. In the **Authentication** section, copy the **Name slug**.
49-
50-
<br />
51-
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1723760323/google-sheets-name-slug_gwa4rb.png" alt="Google Sheets name slug" width={550} height={300} />
52-
53-
#### Creating a custom OAuth client
54-
55-
First, [create an OAuth client](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) for the app you'd like to integrate.
56-
57-
<Callout type="warning">
58-
Make sure to check the **Enable for Pipedream Connect** setting in the OAuth client configuration in Pipedream to allow your end users to connect their accounts. By default, OAuth clients are accessible only to members of your Pipedream workspace. Checking this box allows your end users to create accounts for this app, too.
59-
60-
<br />
61-
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1723760958/enable-oauth-client-for-pd-connect_ipkzmo.png" alt="Enable OAuth client for Pipedream Connect" width={450} height={300} />
62-
</Callout>
63-
64-
Once that's done, copy the **OAuth App ID** from the app configuration.
65-
66-
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1723761240/copy-oauth-app-id_on6d8p.png" alt="Copy your OAuth app ID" width={550} height={300} />
42+
**OAuth apps require you [create your own OAuth client](#creating-a-custom-oauth-client):**
43+
- First, [create an OAuth client](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) for the app you'd like to integrate.
44+
- Now when selecting an OAuth app in the **Apps** tab, you'll be prompted to select the OAuth client you've created.
6745

6846
### Get your project keys
6947

70-
1. Open an existing Pipedream project or create a new one at [https://pipedream.com/projects](https://pipedream.com/projects).
71-
2. Visit the **Connect** tab, then select **Configuration**.
48+
1. From within the the **Connect** tab in your project, select **Configuration**.
7249
3. Find your project's **Public Key** and **Secret Key**.
7350

7451
You'll need these when configuring the SDK and making API requests.
@@ -77,7 +54,7 @@ You'll need these when configuring the SDK and making API requests.
7754

7855
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1724773559/connect-keys_cb4ujt.png" alt="Project keys in the Connect tab" width={650} height={300} />
7956

80-
### Run the Pipedream demo app, or configure your own
57+
### Run the Pipedream demo app or configure your own
8158

8259
You'll need to do two things to integrate Pipedream Connect into your app:
8360

@@ -95,10 +72,6 @@ cp .env.example .env.local
9572
and fill the `.env.local` file with your project and app details:
9673

9774
```bash
98-
# Specific to Next.js — see `app/page.tsx` for how these are used
99-
NEXT_PUBLIC_PIPEDREAM_APP_SLUG=github
100-
NEXT_PUBLIC_PIPEDREAM_APP_ID=oa_abc123
101-
10275
# Used by `app/server.ts` to authorize requests to the Pipedream API — see below
10376
PIPEDREAM_PROJECT_PUBLIC_KEY=pub_abc123
10477
PIPEDREAM_PROJECT_SECRET_KEY=sec_abc123
@@ -112,8 +85,8 @@ If you're building your own app, you'll need to provide these values to the envi
11285
**Why do I need to talk to the Pipedream API from my server?**
11386

11487
You need to secure specific operations, for example:
115-
116-
- You need to initiate the account connection flow for your end users. In Pipedream Connect, **you exchange your project keys for a short-lived token that allows a specific user to connect a specific app**, and return that token to your frontend. If you expose your Pipedream project keys directly to the frontend, anyone could initiate the account connection flow for any user, and you'd be charged for those accounts.
88+
- You need to initiate the account connection flow for your end users. In Pipedream Connect, **you exchange your project keys for a short-lived token that allows a specific user to connect a specific app**, and return that token to your frontend.
89+
- If you expose your Pipedream project keys directly to the frontend, anyone could initiate the account connection flow for any user, and you'd be charged for those accounts.
11790
- You need to retrieve account credentials for your end users. Again, this should happen securely on your server, not in the frontend, to protect your users' data.
11891

11992
</Callout>

0 commit comments

Comments
 (0)