Skip to content

Commit 6cc88ad

Browse files
Danny/connect docs envs (#15744)
* Update environments.mdx * Update environments.mdx * Update pnpm-lock.yaml * Update pnpm-lock.yaml * Update environments.mdx
1 parent 486067e commit 6cc88ad

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

docs-v2/pages/connect/environments.mdx

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,25 @@ Pipedream Connect projects support two environments: `development` and `producti
99
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.
1010
</Callout>
1111

12+
## Development mode
13+
14+
Development mode provides access to all Connect features while you're building and testing your integration. It has the following constraints:
15+
16+
- **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.
17+
- **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.
18+
- **Personal testing only**: Development mode is intended for your own accounts during testing and development, not for your real end users.
19+
20+
<Callout type="warning">
21+
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.
22+
</Callout>
23+
24+
<br />
25+
26+
<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} />
1227

1328
## How to specify the environment
1429

15-
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.
30+
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.
1631

1732
Always set the environment when you create the SDK client:
1833

@@ -28,22 +43,25 @@ const pd = createBackendClient({
2843
});
2944
```
3045

31-
or pass the `X-PD-Environment` header in HTTP requests:
46+
or pass the `x-pd-environment` header in HTTP requests:
3247

3348
```bash
3449
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/tokens \
3550
-H "Content-Type: application/json" \
36-
-H "X-PD-Environment: development" \
51+
-H "x-pd-environment: development" \
3752
-H "Authorization: Bearer {access_token}" \
3853
-d '{
3954
"external_user_id": "your-external-user-id"
4055
}'
4156
```
4257

43-
<Callout type="warning">
44-
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.**
45-
</Callout>
58+
## Shipping Connect to production
4659

47-
<br />
60+
When you're ready to ship to production:
4861

49-
<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} />
62+
1. Contact the [Pipedream Sales team](https://pipedream.com/pricing?plan=Enterprise) to enable production access
63+
2. Update your environment to `production` in your SDK client configuration and / or API calls
64+
65+
<Callout type="info">
66+
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.
67+
</Callout>

0 commit comments

Comments
 (0)