diff --git a/docs-v2/pages/connect/environments.mdx b/docs-v2/pages/connect/environments.mdx index aefe5b1e79c15..80489e69c9cc0 100644 --- a/docs-v2/pages/connect/environments.mdx +++ b/docs-v2/pages/connect/environments.mdx @@ -1,4 +1,5 @@ import Callout from '@/components/Callout' +import Image from 'next/image' # Environments @@ -7,6 +8,14 @@ Pipedream Connect projects support two environments: `development` and `producti 1. Connected accounts and credentials stored in `development` remain separate from `production`. 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). + +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. + + +
+ +Connect in development mode + ## How to specify environment 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. diff --git a/docs-v2/pages/connect/oauth-clients.mdx b/docs-v2/pages/connect/oauth-clients.mdx index 130a955874a36..15ade34c7bc69 100644 --- a/docs-v2/pages/connect/oauth-clients.mdx +++ b/docs-v2/pages/connect/oauth-clients.mdx @@ -12,12 +12,20 @@ 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 Connect to production](/connect/environments):** - -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. +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. +
+ +
+| Operation | Details | Environment | +|--------|---------|------------------------------| +| [Retrieve credentials via API](/connect/api#accounts) | Fetch the credentials for your end user from Pipedream's API to use in your application. | ✅ `development`
❌ `production` | +| [Invoke workflows](/connect/workflows) | Trigger any Pipedream workflow and use the connected account of your end user | ✅ `development`
❌ `production` | +| Run components via API (coming soon) | Run any action and deploy any trigger directly from your application | ✅ `development`
✅ `production` | +
+ ## Using a custom OAuth client 1. Follow the steps [here](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) to create an OAuth client in Pipedream. diff --git a/docs-v2/styles/globals.css b/docs-v2/styles/globals.css index 7733a4d1817bb..e49aec4ab2f7a 100644 --- a/docs-v2/styles/globals.css +++ b/docs-v2/styles/globals.css @@ -47,3 +47,11 @@ html.dark { .DocSearch input.DocSearch-Input:focus-visible { box-shadow: none; } + +.highlightHeaderRowTable th { + background-color: #f6f8fa; +} + +.highlightHeaderRowTable td:last-child { + white-space: nowrap; +} \ No newline at end of file diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7e96d1d061a6a..95a1b77b37ac2 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1693,8 +1693,7 @@ importers: specifier: ^1.5.1 version: 1.6.6 - components/checkout_com: - specifiers: {} + components/checkout_com: {} components/checkvist: dependencies: @@ -13393,12 +13392,12 @@ packages: '@dabh/diagnostics@2.0.3': resolution: {integrity: sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==} - '@definitelytyped/header-parser@0.2.15': - resolution: {integrity: sha512-SRUpmhQ7QZpsjLiA9SlwaD2Ct1xOc5Vt8cpZAqQ+P/puu4nNIsibCW87NKkyjCXG+MCUVFWEK7rVCTd12m2hTw==} + '@definitelytyped/header-parser@0.2.16': + resolution: {integrity: sha512-UFsgPft5bhZn07UNGz/9ck4AhdKgLFEOmi2DNr7gXcGL89zbe3u5oVafKUT8j1HOtSBjT8ZEQsXHKlbq+wwF/Q==} engines: {node: '>=18.18.0'} - '@definitelytyped/typescript-versions@0.1.5': - resolution: {integrity: sha512-XdLx3+S6zZCcG4jnG6Kqv/PlKBRTkz5M/xZUEEN9R2g6BlzbxyE+z5EzlezJqkUls53zjuOzgbkNNP4HQIfbJQ==} + '@definitelytyped/typescript-versions@0.1.6': + resolution: {integrity: sha512-gQpXFteIKrOw4ldmBZQfBrD3WobaIG1SwOr/3alXWkcYbkOWa2NRxQbiaYQ2IvYTGaZK26miJw0UOAFiuIs4gA==} engines: {node: '>=18.18.0'} '@definitelytyped/utils@0.1.8': @@ -26715,13 +26714,13 @@ snapshots: enabled: 2.0.0 kuler: 2.0.0 - '@definitelytyped/header-parser@0.2.15': + '@definitelytyped/header-parser@0.2.16': dependencies: - '@definitelytyped/typescript-versions': 0.1.5 + '@definitelytyped/typescript-versions': 0.1.6 '@definitelytyped/utils': 0.1.8 semver: 7.6.3 - '@definitelytyped/typescript-versions@0.1.5': {} + '@definitelytyped/typescript-versions@0.1.6': {} '@definitelytyped/utils@0.1.8': dependencies: @@ -32219,7 +32218,7 @@ snapshots: dts-critic@3.3.11(typescript@5.7.2): dependencies: - '@definitelytyped/header-parser': 0.2.15 + '@definitelytyped/header-parser': 0.2.16 command-exists: 1.2.9 rimraf: 3.0.2 semver: 6.3.1 @@ -32229,8 +32228,8 @@ snapshots: dtslint@4.2.1(typescript@5.7.2): dependencies: - '@definitelytyped/header-parser': 0.2.15 - '@definitelytyped/typescript-versions': 0.1.5 + '@definitelytyped/header-parser': 0.2.16 + '@definitelytyped/typescript-versions': 0.1.6 '@definitelytyped/utils': 0.1.8 dts-critic: 3.3.11(typescript@5.7.2) fs-extra: 6.0.1