Skip to content

Commit fd9047c

Browse files
tjklcaresia
authored andcommitted
chore(docs): project_environment -> environment_name (before client-create environment fully lands)
1 parent a1ee41c commit fd9047c

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

docs-v2/pages/connect/api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ Pipedream will send events on successful auth, or any errors, to this URL via we
224224

225225
---
226226

227-
`project_environment` **string** (_optional_)
227+
`environment_name` **string** (_optional_)
228228

229229
Specify the environment (`production` or `development`) to use for the account connection flow. Defaults to `production`.
230230

@@ -933,4 +933,4 @@ curl -X POST https://api.pipedream.com/v1/connect/{project_id}/info \
933933
-H "Authorization: Bearer {access_token}" \
934934
```
935935
</Tabs.Tab>
936-
</Tabs>
936+
</Tabs>

docs-v2/pages/connect/environments.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ Pipedream Connect projects support two environments: `development` and `producti
77

88
## How to specify environment
99

10-
You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. By default, the enviromment is set to `production`. When users succesfully connect their account, Pipedream saves it for that `external_user_id` in the specified `project_environment`.
10+
You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. By default, the enviromment is set to `production`. When users succesfully connect their account, Pipedream saves it for that `external_user_id` in the specified `environment_name`.

docs-v2/pages/connect/tokens.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ When you generate a token, you can specify a `webhook_uri` where Pipedream will
2121

2222
## Tokens are scoped to end users and project environments
2323

24-
When you [create a new Connect token](/connect/api/#create-a-new-token), you pass an `external_user_id` and an optional `project_environment` parameter. By default, the environment is set to `production`. See the docs on [environments](/connect/environments) for more information.
24+
When you [create a new Connect token](/connect/api/#create-a-new-token), you pass an `external_user_id` and an optional `environment_name` parameter. By default, the environment is set to `production`. See the docs on [environments](/connect/environments) for more information.
2525

26-
Tokens are scoped to this user and environment. When the user successfully connects an account with that token, it will be saved for that `external_user_id` in the specified `project_environment`.
26+
Tokens are scoped to this user and environment. When the user successfully connects an account with that token, it will be saved for that `external_user_id` in the specified `environment_name`.

packages/sdk/src/server/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ export type ConnectTokenOpts = {
8888
* Specify the environment ("production" or "development") to use for the
8989
* account connection flow. Defaults to "production".
9090
*/
91-
project_environment?: string;
91+
environment_name?: string;
9292
};
9393

9494
export type AppInfo = {

0 commit comments

Comments
 (0)