Skip to content

Commit a2ee3ab

Browse files
review feedback
1 parent 2fdc30e commit a2ee3ab

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs-v2/pages/connect/index.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,12 @@ All credentials and tokens are sent to Pipedream securely over HTTPS, and encryp
8080
- Invoke Pipedream workflows on behalf of end users
8181
- Support hosted UIs for connecting accounts — native support for mobile environments that can't execute JavaScript or load iframes.
8282
- Improve error handling for Connect developers and end users
83-
- And more!
83+
- And more!
84+
85+
## Glossary of terms
86+
87+
- **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).
88+
- **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.
89+
- **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.
90+
- **Connected Account**: The account your end user connects. [Read more about connected accounts](/connected-accounts).
91+
- **OAuth Client**: Custom OAuth clients you create in Pipedream. [Read more about OAuth clients](/connected-accounts/oauth-clients).

docs-v2/pages/connect/quickstart.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ There are two types of apps in Pipedream:
4040
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.
4141

4242
**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.
43+
1. First, [create an OAuth client](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) for the app you'd like to integrate.
44+
2. Now when selecting an OAuth app in the **Apps** tab, you'll be prompted to select the OAuth client you've created.
4545

4646
### Get your project keys
4747

@@ -85,6 +85,7 @@ If you're building your own app, you'll need to provide these values to the envi
8585
**Why do I need to talk to the Pipedream API from my server?**
8686

8787
You need to secure specific operations, for example:
88+
8889
- 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.
8990
- 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.
9091
- 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.

0 commit comments

Comments
 (0)