From da4887ae8d99e6db732e563ec2697513527e85cf Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Tue, 25 Feb 2025 15:34:03 -0800 Subject: [PATCH 1/5] Update environments.mdx --- docs-v2/pages/connect/environments.mdx | 34 ++++++++++++++++++++------ 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/docs-v2/pages/connect/environments.mdx b/docs-v2/pages/connect/environments.mdx index 6daf5b2b3162d..d4b934791950c 100644 --- a/docs-v2/pages/connect/environments.mdx +++ b/docs-v2/pages/connect/environments.mdx @@ -9,10 +9,25 @@ Pipedream Connect projects support two environments: `development` and `producti You can use all of the Connect features in `development` mode **on any plan**. **[Get in touch with our Sales team](https://pipedream.com/pricing?plan=Enterprise)** when you're ready to ship to production. +## Development mode + +Development mode provides access to all Connect features while you're building and testing your integration. It has the following constraints: + +- **Maximum of 10 external users**: The development environment is limited to 10 unique external user IDs. If you exceed this limit, you'll need to [delete some existing users](/connect/managed-auth/users/#deleting-users) before adding new ones. +- **Browser authentication required**: When connecting an account in development mode, you must be signed in to pipedream.com in the same browser where you're connecting your account. +- **Personal testing only**: Development mode is intended for your own accounts during testing and development, not for your real end users. + + +The `development` environment is not intended for production use with your customers. When you're ready to launch, you should to transition to the `production` environment. + + +
+ +Connect in development mode ## How to specify the environment -You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. When users succesfully connect their account, Pipedream saves the account credentials (API key, access token, etc) for that `external_user_id` in the specified environment. +You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. When users successfully connect their account, Pipedream saves the account credentials (API key, access token, etc) for that `external_user_id` in the specified environment. Always set the environment when you create the SDK client: @@ -28,22 +43,25 @@ const pd = createBackendClient({ }); ``` -or pass the `X-PD-Environment` header in HTTP requests: +or pass the `x-pd-environment` header in HTTP requests: ```bash curl -X POST https://api.pipedream.com/v1/connect/{project_id}/tokens \ -H "Content-Type: application/json" \ - -H "X-PD-Environment: development" \ + -H "x-pd-environment: development" \ -H "Authorization: Bearer {access_token}" \ -d '{ "external_user_id": "your-external-user-id" }' ``` - -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. **You should only use `development` with your own accounts when testing and developing, and not with your end users.** - +## Shipping Connect to production -
+When you're ready to ship to production: -Connect in development mode +1. Contact the [Pipedream Sales team](https://pipedream.com/pricing?plan=Enterprise) to enable production access +2. Update your environment to `production` in your SDK client configuration and / or API calls + + +Using Connect in production doesn't have any user limits and doesn't require that the end user is signed in to pipedream.com like the development environment does. + \ No newline at end of file From c8d6aa2167889ecec9bc2262ea38aae98dff77fa Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Tue, 25 Feb 2025 15:34:39 -0800 Subject: [PATCH 2/5] Update environments.mdx --- docs-v2/pages/connect/environments.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-v2/pages/connect/environments.mdx b/docs-v2/pages/connect/environments.mdx index d4b934791950c..fe5548ce22e31 100644 --- a/docs-v2/pages/connect/environments.mdx +++ b/docs-v2/pages/connect/environments.mdx @@ -14,7 +14,7 @@ You can use all of the Connect features in `development` mode **on any plan**. * Development mode provides access to all Connect features while you're building and testing your integration. It has the following constraints: - **Maximum of 10 external users**: The development environment is limited to 10 unique external user IDs. If you exceed this limit, you'll need to [delete some existing users](/connect/managed-auth/users/#deleting-users) before adding new ones. -- **Browser authentication required**: When connecting an account in development mode, you must be signed in to pipedream.com in the same browser where you're connecting your account. +- **Must be signed in to pipedream.com**: When connecting an account in development mode, you must be signed in to pipedream.com in the same browser where you're connecting your account. - **Personal testing only**: Development mode is intended for your own accounts during testing and development, not for your real end users. From 8367f8e403ddc14d591c7ed1afd4e4bbe4546775 Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Tue, 25 Feb 2025 15:35:04 -0800 Subject: [PATCH 3/5] Update pnpm-lock.yaml --- pnpm-lock.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index cf88c0d8585ab..e47442f6ff779 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -14752,7 +14752,7 @@ importers: version: 3.1.7 ts-jest: specifier: ^29.2.5 - version: 29.2.5(@babel/core@7.26.0)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@7.26.0))(esbuild@0.24.2)(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.7.2) + version: 29.2.5(@babel/core@8.0.0-alpha.13)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@8.0.0-alpha.13))(esbuild@0.24.2)(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.7.2) tsup: specifier: ^8.3.6 version: 8.3.6(@microsoft/api-extractor@7.47.12(@types/node@20.17.6))(jiti@1.21.6)(postcss@8.4.49)(typescript@5.7.2)(yaml@2.6.1) @@ -46812,7 +46812,7 @@ snapshots: ts-interface-checker@0.1.13: {} - ts-jest@29.2.5(@babel/core@7.26.0)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@7.26.0))(esbuild@0.24.2)(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.7.2): + ts-jest@29.2.5(@babel/core@8.0.0-alpha.13)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@8.0.0-alpha.13))(esbuild@0.24.2)(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.7.2): dependencies: bs-logger: 0.2.6 ejs: 3.1.10 @@ -46826,10 +46826,10 @@ snapshots: typescript: 5.7.2 yargs-parser: 21.1.1 optionalDependencies: - '@babel/core': 7.26.0 + '@babel/core': 8.0.0-alpha.13 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - babel-jest: 29.7.0(@babel/core@7.26.0) + babel-jest: 29.7.0(@babel/core@8.0.0-alpha.13) esbuild: 0.24.2 ts-jest@29.2.5(@babel/core@8.0.0-alpha.13)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@8.0.0-alpha.13))(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.6.3): From 35771d6632c8447879b40dfca9cf8083c936b990 Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Tue, 25 Feb 2025 15:35:57 -0800 Subject: [PATCH 4/5] Update pnpm-lock.yaml --- pnpm-lock.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e47442f6ff779..cf88c0d8585ab 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -14752,7 +14752,7 @@ importers: version: 3.1.7 ts-jest: specifier: ^29.2.5 - version: 29.2.5(@babel/core@8.0.0-alpha.13)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@8.0.0-alpha.13))(esbuild@0.24.2)(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.7.2) + version: 29.2.5(@babel/core@7.26.0)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@7.26.0))(esbuild@0.24.2)(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.7.2) tsup: specifier: ^8.3.6 version: 8.3.6(@microsoft/api-extractor@7.47.12(@types/node@20.17.6))(jiti@1.21.6)(postcss@8.4.49)(typescript@5.7.2)(yaml@2.6.1) @@ -46812,7 +46812,7 @@ snapshots: ts-interface-checker@0.1.13: {} - ts-jest@29.2.5(@babel/core@8.0.0-alpha.13)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@8.0.0-alpha.13))(esbuild@0.24.2)(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.7.2): + ts-jest@29.2.5(@babel/core@7.26.0)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@7.26.0))(esbuild@0.24.2)(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.7.2): dependencies: bs-logger: 0.2.6 ejs: 3.1.10 @@ -46826,10 +46826,10 @@ snapshots: typescript: 5.7.2 yargs-parser: 21.1.1 optionalDependencies: - '@babel/core': 8.0.0-alpha.13 + '@babel/core': 7.26.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - babel-jest: 29.7.0(@babel/core@8.0.0-alpha.13) + babel-jest: 29.7.0(@babel/core@7.26.0) esbuild: 0.24.2 ts-jest@29.2.5(@babel/core@8.0.0-alpha.13)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@8.0.0-alpha.13))(jest@29.7.0(@types/node@20.17.6)(babel-plugin-macros@3.1.0))(typescript@5.6.3): From 01cf4c78a4f65bdbb6267a539f83d4025503fb1a Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Tue, 25 Feb 2025 15:53:52 -0800 Subject: [PATCH 5/5] Update environments.mdx --- docs-v2/pages/connect/environments.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-v2/pages/connect/environments.mdx b/docs-v2/pages/connect/environments.mdx index fe5548ce22e31..bfd5b669cd86c 100644 --- a/docs-v2/pages/connect/environments.mdx +++ b/docs-v2/pages/connect/environments.mdx @@ -18,7 +18,7 @@ Development mode provides access to all Connect features while you're building a - **Personal testing only**: Development mode is intended for your own accounts during testing and development, not for your real end users. -The `development` environment is not intended for production use with your customers. When you're ready to launch, you should to transition to the `production` environment. +The `development` environment is not intended for production use with your customers. When you're ready to launch, you should transition to the `production` environment.
@@ -27,7 +27,7 @@ The `development` environment is not intended for production use with your custo ## How to specify the environment -You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. When users successfully connect their account, Pipedream saves the account credentials (API key, access token, etc) for that `external_user_id` in the specified environment. +You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. When users successfully connect their account, Pipedream saves the account credentials (API key, access token, etc.) for that `external_user_id` in the specified environment. Always set the environment when you create the SDK client: