Skip to content

Commit d5b256b

Browse files
More info re: OAuth clients
1 parent 1e2ef10 commit d5b256b

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed
Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,35 @@
11
import Image from 'next/image'
2+
import Callout from '@/components/Callout'
23

34
# OAuth Clients
45

5-
When connecting an account for any OAuth app via Pipedream Connect, we'll default to using Pipedream's official OAuth client, which enables you to quick get up and running. [Read more about OAuth clients in Pipedream here](/connected-accounts/oauth-clients).
6+
When connecting an account for any OAuth app via Pipedream Connect, we'll default to using Pipedream's official OAuth client, which enables you to quickly get up and running. [Read more about OAuth clients in Pipedream here](/connected-accounts/oauth-clients).
7+
8+
## Using Pipedream OAuth
9+
10+
There are two types of apps in Pipedream:
11+
12+
1. **Key-based**: These apps require static credentials, like API keys. Pipedream stores these credentials securely and exposes them via API.
13+
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.
14+
15+
**OAuth apps require you create your own OAuth client to [deploy to production](/connect/environments):**
16+
17+
<Callout type="info">
18+
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.
19+
</Callout>
620

721
## Using a custom OAuth client
8-
1. Follow the steps outlined [here](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) to create an OAuth client in Pipedream.
22+
23+
1. Follow the steps [here](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) to create an OAuth client in Pipedream.
924
2. Open the **Apps** tab within your Pipedream project and select **Add app**.
10-
3. Select the app you're looking for, then select the OAuth client from the dropdown menu
11-
4. When connecting an account either via the [frontend SDK](/connect/quickstart#use-the-pipedream-sdk-in-your-frontend) or using [Connect Link](/connect/quickstart#use-connect-link), make sure to include the `oauth_app_id` in the request.
25+
3. Select the app you're looking for, then select your OAuth client from the dropdown menu.
26+
4. When connecting an account either via the [frontend SDK](/connect/quickstart#use-the-pipedream-sdk-in-your-frontend), make sure to include the `oauth_app_id` in `pd.connectAccount()`.
27+
5. If using [Connect Link](/connect/quickstart#use-connect-link), make sure to include the `oauth_app_id` in the URL.
28+
29+
### Finding your OAuth app ID
1230

13-
## Finding your OAuth app ID
1431
[Create your OAuth client in Pipedream](https://pipedream.com/@/accounts/oauth-clients) then click the arrow to the left of the client name to expand the details.
1532

16-
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1730241292/oauth-app-id_umhhqi.png" alt="Copy OAuth App ID" width={650} height={529} />
33+
<br />
1734

18-
## Using Pipedream OAuth clients
35+
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1730241292/oauth-app-id_umhhqi.png" alt="Copy OAuth App ID" width={650} height={529} />

0 commit comments

Comments
 (0)