Skip to content

Commit fc7ebe1

Browse files
Danny/connect oauth docs update (#14743)
* Adding info on OAuth client usage, more envs info * Update pnpm-lock.yaml
1 parent 5f75543 commit fc7ebe1

File tree

4 files changed

+39
-15
lines changed

4 files changed

+39
-15
lines changed

docs-v2/pages/connect/environments.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import Callout from '@/components/Callout'
2+
import Image from 'next/image'
23

34
# Environments
45

@@ -7,6 +8,14 @@ Pipedream Connect projects support two environments: `development` and `producti
78
1. Connected accounts and credentials stored in `development` remain separate from `production`.
89
2. In `development`, you can use the official Pipedream OAuth clients, so you can test integrations without creating your own OAuth client, and you can also use features that are typically only available on higher paid tiers, like [running workflows on behalf of your end users](/connect/workflows).
910

11+
<Callout type="warning">
12+
When connecting an account in `development`, make sure you're signed in to pipedream.com in the same browser where you're connecting your account. This is only a requirement for the `development` environment.
13+
</Callout>
14+
15+
<br />
16+
17+
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1732654019/Google_Chrome_-_Pipedream_Connect_2024-11-26_at_12.45.06_PM_yp4gnl.png" alt="Connect in development mode" width={350} height={529} />
18+
1019
## How to specify environment
1120

1221
You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. By default, the enviromment is set to `production`. When users succesfully connect their account, Pipedream saves it for that `external_user_id` in the specified environment.

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

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,20 @@ 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 Connect to production](/connect/environments):**
16-
1715
<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.
16+
For any OAuth app that supports it, **you can always use your own client.** Your ability to use Pipedream's OAuth clients in production depends on the use case.
1917
</Callout>
2018

19+
<br />
20+
21+
<div className="highlightHeaderRowTable">
22+
| Operation | Details | Environment |
23+
|--------|---------|------------------------------|
24+
| [Retrieve credentials via API](/connect/api#accounts) | Fetch the credentials for your end user from Pipedream's API to use in your application. |`development`<br />❌ `production` |
25+
| [Invoke workflows](/connect/workflows) | Trigger any Pipedream workflow and use the connected account of your end user |`development`<br />❌ `production` |
26+
| Run components via API (coming soon) | Run any action and deploy any trigger directly from your application |`development`<br />✅ `production` |
27+
</div>
28+
2129
## Using a custom OAuth client
2230

2331
1. Follow the steps [here](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) to create an OAuth client in Pipedream.

docs-v2/styles/globals.css

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,11 @@ html.dark {
4747
.DocSearch input.DocSearch-Input:focus-visible {
4848
box-shadow: none;
4949
}
50+
51+
.highlightHeaderRowTable th {
52+
background-color: #f6f8fa;
53+
}
54+
55+
.highlightHeaderRowTable td:last-child {
56+
white-space: nowrap;
57+
}

pnpm-lock.yaml

Lines changed: 11 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)