-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1e2ef10
commit d5b256b
Showing
1 changed file
with
24 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,35 @@ | ||
import Image from 'next/image' | ||
import Callout from '@/components/Callout' | ||
|
||
# OAuth Clients | ||
|
||
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). | ||
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). | ||
|
||
## Using Pipedream OAuth | ||
|
||
There are two types of apps in Pipedream: | ||
|
||
1. **Key-based**: These apps require static credentials, like API keys. Pipedream stores these credentials securely and exposes them via API. | ||
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. | ||
|
||
**OAuth apps require you create your own OAuth client to [deploy to production](/connect/environments):** | ||
|
||
<Callout type="info"> | ||
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. | ||
</Callout> | ||
|
||
## Using a custom OAuth client | ||
1. Follow the steps outlined [here](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) to create an OAuth client in Pipedream. | ||
|
||
1. Follow the steps [here](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) to create an OAuth client in Pipedream. | ||
2. Open the **Apps** tab within your Pipedream project and select **Add app**. | ||
3. Select the app you're looking for, then select the OAuth client from the dropdown menu | ||
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. | ||
3. Select the app you're looking for, then select your OAuth client from the dropdown menu. | ||
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()`. | ||
5. If using [Connect Link](/connect/quickstart#use-connect-link), make sure to include the `oauth_app_id` in the URL. | ||
|
||
### Finding your OAuth app ID | ||
|
||
## Finding your OAuth app ID | ||
[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. | ||
|
||
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1730241292/oauth-app-id_umhhqi.png" alt="Copy OAuth App ID" width={650} height={529} /> | ||
<br /> | ||
|
||
## Using Pipedream OAuth clients | ||
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1730241292/oauth-app-id_umhhqi.png" alt="Copy OAuth App ID" width={650} height={529} /> |