Skip to content

Commit

Permalink
Danny/connect docs envs (#15744)
Browse files Browse the repository at this point in the history
* Update environments.mdx

* Update environments.mdx

* Update pnpm-lock.yaml

* Update pnpm-lock.yaml

* Update environments.mdx
  • Loading branch information
dannyroosevelt authored Feb 25, 2025
1 parent 486067e commit 6cc88ad
Showing 1 changed file with 26 additions and 8 deletions.
34 changes: 26 additions & 8 deletions docs-v2/pages/connect/environments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Callout>

## 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.
- **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.

<Callout type="warning">
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.
</Callout>

<br />

<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} />

## 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:

Expand All @@ -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"
}'
```

<Callout type="warning">
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.**
</Callout>
## Shipping Connect to production

<br />
When you're ready to ship to production:

<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} />
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

<Callout type="info">
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.
</Callout>

0 comments on commit 6cc88ad

Please sign in to comment.