Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Danny/connect docs envs #15744

Merged
merged 5 commits into from
Feb 25, 2025
Merged

Danny/connect docs envs #15744

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
da4887a
Update environments.mdx
dannyroosevelt Feb 25, 2025
c8d6aa2
Update environments.mdx
dannyroosevelt Feb 25, 2025
8367f8e
Update pnpm-lock.yaml
dannyroosevelt Feb 25, 2025
35771d6
Update pnpm-lock.yaml
dannyroosevelt Feb 25, 2025
01cf4c7
Update environments.mdx
dannyroosevelt Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions docs-v2/pages/connect/environments.mdx
View file
Open in desktop
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 to transition to the `production` environment.
</Callout>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Wording Revision in Warning Callout
There is a minor grammatical issue on line 21: the phrase “you should to transition” should be revised to “you should transition” for clarity.

Suggested diff:

-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.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

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