Environments

Pipedream Connect projects support two environments: development and production. Connected accounts and credentials stored in development remain separate from 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 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.

How to specify the environment

You specify the environment when creating a new Connect 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:

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "your-oauth-client-id",
    clientSecret: "your-oauth-client-secret",
  }
});

or pass the x-pd-environment header in HTTP requests:

curl -X POST https://api.pipedream.com/v1/connect/{project_id}/tokens \
  -H "Content-Type: application/json" \
  -H "x-pd-environment: development" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "your-external-user-id"
  }'

Shipping Connect to production

When you’re ready to ship to production:

1. Contact the Pipedream Sales team to enable production access
2. Update your environment to production in your SDK client configuration and / or API calls