You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-v2/pages/account/billing-settings.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ import Callout from '@/components/Callout'
2
2
3
3
# Billing Settings
4
4
5
-
You'll find information on your usage data (for specific [Pipedream limits](/workflows/limits/)) in your [Billing Settings](https://pipedream.com/settings/billing). You can also upgrade to [paid plans](https://pipedream.com/pricing) from this page.
5
+
You'll find information on your usage data (for specific [Pipedream limits](/core/limits/)) in your [Billing Settings](https://pipedream.com/settings/billing). You can also upgrade to [paid plans](https://pipedream.com/pricing) from this page.
6
6
7
7
## Subscription
8
8
@@ -40,4 +40,4 @@ In an example scenario, with cap set at 20 credits and long running workflow tha
40
40
41
41
## Limits
42
42
43
-
For users on the [Free tier](/pricing/#free-tier), this section displays your usage towards your [credits quota](/workflows/limits/#daily-credits-limit) for the current UTC day.
43
+
For users on the [Free tier](/pricing/#free-tier), this section displays your usage towards your [credits quota](/core/limits/#daily-credits-limit) for the current UTC day.
Copy file name to clipboardExpand all lines: docs-v2/pages/account/user-settings.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ Pipedream recommends enabling 2FA with your identity provider.
50
50
51
51
### Requiring 2-Factor Authentication
52
52
53
-
Workspaces on the Business plan can [require all workspace members to configure 2FA](/workflows/workspaces/#requiring-two-factor-authentication) in order to log in to Pipedream.
53
+
Workspaces on the Business plan can [require all workspace members to configure 2FA](/core/workspaces/#requiring-two-factor-authentication) in order to log in to Pipedream.
54
54
55
55
If you are a member of any workspace where 2FA is required, you cannot disable 2FA, but you can still reconfigure it in your [account settings](https://pipedream.com/account/) if necessary.
56
56
@@ -62,7 +62,7 @@ Only workspace owner and admin members can enable or disable 2FA for an entire w
62
62
63
63
## Pipedream API Key
64
64
65
-
Pipedream provides a [REST API](/api/) for interacting with Pipedream programmatically. You'll find your API key here, which you use to [authorize requests to the API](/workflows/rest-api/auth/).
65
+
Pipedream provides a [REST API](/api/) for interacting with Pipedream programmatically. You'll find your API key here, which you use to [authorize requests to the API](/core/rest-api/auth/).
66
66
67
67
You can revoke and regenerate your API key from here at any time.
68
68
@@ -82,4 +82,4 @@ For example, you can:
82
82
83
83
## Environment Variables
84
84
85
-
Environment variables allow you to securely store secrets or other config values that you can access in Pipedream workflows via `process.env`. [Read more about environment variables here](/workflows/environment-variables/).
85
+
Environment variables allow you to securely store secrets or other config values that you can access in Pipedream workflows via `process.env`. [Read more about environment variables here](/core/environment-variables/).
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/api-proxy.mdx
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,8 @@ import Callout from '@/components/Callout'
5
5
6
6
Pipedream Connect provides a proxy API that you can use to send authenticated requests to any integrated API on behalf of your users, which is useful in a few scenarios:
7
7
8
-
1. You need code-level control and you want to use [Pipedream's OAuth](/connect/managed-auth/oauth-clients#using-pipedream-oauth) instead of [your own OAuth client](/connect/managed-auth/oauth-clients#using-a-custom-oauth-client)
9
-
2. There isn't a [pre-built tool](/connect/components) (action) for the app, or you need to modify the request
8
+
1. You need code-level control and you want to use [Pipedream's OAuth](/connect/managed-auth/oauth-clients/#using-pipedream-oauth) instead of [your own OAuth client](/connect/managed-auth/oauth-clients/#using-a-custom-oauth-client)
9
+
2. There isn't a [pre-built tool](/connect/components/) (action) for the app, or you need to modify the request
10
10
3. You want to avoid storing end user credentials in your app
11
11
12
12
## Overview
@@ -20,19 +20,19 @@ The Connect proxy enables you to interface with any integrated API and make auth
20
20
21
21
22
22
<Callouttype="info">
23
-
Before getting started with the Connect proxy, make sure you've already gone through the [managed auth quickstart](/connect/managed-auth/quickstart) for Pipedream Connect.
23
+
Before getting started with the Connect proxy, make sure you've already gone through the [managed auth quickstart](/connect/managed-auth/quickstart/) for Pipedream Connect.
24
24
</Callout>
25
25
26
26
## Getting started
27
27
28
-
You can send requests to the Connect proxy using the [Pipedream SDK](/connect/sdk) with a fetch-style interface, or by making a request to the [REST API](/workflows/rest-api/connect/proxy).
28
+
You can send requests to the Connect proxy using the [Pipedream SDK](/connect/sdk/) with a fetch-style interface, or by making a request to the [REST API](/core/rest-api/connect/proxy/).
29
29
30
-
- A [Pipedream OAuth client](/workflows/rest-api/auth#oauth) to make authenticated requests to Pipedream's API
31
-
- Connect [environment](/connect/environments) (ex, `production` or `development`)
32
-
- The [external user ID](/connect/api#external-users) for your end user (ex, `abc-123`)
33
-
- The [account ID](/connect/api#accounts) for your end user's connected account (ex, `apn_1234567`)
30
+
- A [Pipedream OAuth client](/core/rest-api/auth/#oauth) to make authenticated requests to Pipedream's API
31
+
- Connect [environment](/connect/environments/) (ex, `production` or `development`)
32
+
- The [external user ID](/connect/api/#external-users) for your end user (ex, `abc-123`)
33
+
- The [account ID](/connect/api/#accounts) for your end user's connected account (ex, `apn_1234567`)
34
34
35
-
Refer to the full Connect API [here](/connect/api).
35
+
Refer to the full Connect API [here](/connect/api/).
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/api.mdx
+28-28Lines changed: 28 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Pipedream provides a TypeScript SDK and a REST API to interact with the Connect
7
7
8
8
## REST API base URL
9
9
10
-
Pipedream Connect resources are scoped to [projects](/projects), so you'll need to pass [the project's ID](/workflows/projects#finding-your-projects-id) as a part of the base URL:
10
+
Pipedream Connect resources are scoped to [projects](/core/projects/), so you'll need to pass [the project's ID](/core/projects/#finding-your-projects-id) as a part of the base URL:
11
11
12
12
```
13
13
https://api.pipedream.com/v1/connect/{project_id}
@@ -41,13 +41,13 @@ or a specific version:
41
41
42
42
## Authentication
43
43
44
-
See the [REST API Authentication docs](/workflows/rest-api/auth).
44
+
See the [REST API Authentication docs](/core/rest-api/auth/).
45
45
46
46
### TypeScript SDK (server)
47
47
48
48
Most of your interactions with the Connect API will happen on the server, to protect API requests and user credentials. You'll use the SDK in [your frontend](#typescript-sdk-browser) to let users connect accounts. Once connected, you'll use the SDK on the server to retrieve credentials, invoke workflows on their behalf, and more.
49
49
50
-
[Create a Pipedream OAuth client](/workflows/rest-api/auth#oauth) and instantiate the SDK with your client ID and secret:
50
+
[Create a Pipedream OAuth client](/core/rest-api/auth/#oauth) and instantiate the SDK with your client ID and secret:
@@ -104,7 +104,7 @@ export default function Home() {
104
104
105
105
## Environment
106
106
107
-
Some API endpoints accept an [environment](/connect/environments) parameter. This lets you specify the environment (`production` or `development`) where resources will live in your project.
107
+
Some API endpoints accept an [environment](/connect/environments/) parameter. This lets you specify the environment (`production` or `development`) where resources will live in your project.
108
108
109
109
Always set the environment when you create the SDK client:
110
110
@@ -231,13 +231,13 @@ curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/actions/run
231
231
232
232
### Invoke workflows
233
233
234
-
You can use the SDK to [invoke workflows on behalf of any end user](/connect/workflows). **Write one workflow, run it for all of your users**.
234
+
You can use the SDK to [invoke workflows on behalf of any end user](/connect/workflows/). **Write one workflow, run it for all of your users**.
235
235
236
236
### Tokens
237
237
238
238
Your app will initiate the account connection flow for your end users in your frontend. To securely scope connection to a specific end user, on your server, **you retrieve a short-lived token for that user**, and return that token to your frontend.
239
239
240
-
See [the Connect tokens docs](/connect/tokens) for more information.
240
+
See [the Connect tokens docs](/connect/tokens/) for more information.
@@ -272,19 +272,19 @@ When using the Connect API to make requests from a client environment like a bro
272
272
273
273
`success_redirect_uri`**string** (_optional_)
274
274
275
-
When using [Connect Link](/connect/connect-link), you can optionally redirect your end user to the `success_redirect_uri` on successful completion of the auth flow.
275
+
When using [Connect Link](/connect/connect-link/), you can optionally redirect your end user to the `success_redirect_uri` on successful completion of the auth flow.
276
276
277
277
---
278
278
279
279
`error_redirect_uri`**string** (_optional_)
280
280
281
-
When using [Connect Link](/connect/connect-link), you can optionally redirect your end user to the `error_redirect_uri` on any errors in the auth flow. This lets you handle errors in whatever way you want in your own app.
281
+
When using [Connect Link](/connect/connect-link/), you can optionally redirect your end user to the `error_redirect_uri` on any errors in the auth flow. This lets you handle errors in whatever way you want in your own app.
282
282
283
283
---
284
284
285
285
`webhook_uri`**string** (_optional_)
286
286
287
-
Pipedream will send events on successful auth, or any errors, to this URL via webhook. [See the webhooks docs](/connect/webhooks) for more information.
287
+
Pipedream will send events on successful auth, or any errors, to this URL via webhook. [See the webhooks docs](/connect/webhooks/) for more information.
The ID or name slug the app you'd like to retrieve. For example, Slack's unique app ID is `app_OkrhR1`, and its name slug is `slack`.
404
404
405
-
You can find the app's ID in the response from the [List apps](/workflows/rest-api#list-apps) endpoint, and the name slug under the **Authentication** section of any [app page](https://pipedream.com/apps).
405
+
You can find the app's ID in the response from the [List apps]((/core/rest-api/#list-apps) endpoint, and the name slug under the **Authentication** section of any [app page](https://pipedream.com/apps).
406
406
407
407
---
408
408
409
409
`oauth_app_id`**string** (_optional_)
410
410
411
-
The ID of the [OAuth app](/connect/managed-auth/quickstart#create-a-pipedream-oauth-client) you'd like to retrieve accounts for.
411
+
The ID of the [OAuth app](/connect/managed-auth/quickstart/#create-a-pipedream-oauth-client) you'd like to retrieve accounts for.
412
412
413
413
---
414
414
@@ -427,7 +427,7 @@ Never return user credentials to the client
427
427
</Callout>
428
428
429
429
<Callouttype="info">
430
-
To retrieve the credentials for any account in `production` for OAuth apps (Slack, Google Sheets, etc), the connected account must be using [your own OAuth client](/connect/managed-auth/oauth-clients#using-a-custom-oauth-client). You can only retrieve end user credentials for accounts that are using Pipedream's OAuth clients in `development`. [Learn more here](/connect/managed-auth/oauth-clients#using-pipedream-oauth).
430
+
To retrieve the credentials for any account in `production` for OAuth apps (Slack, Google Sheets, etc), the connected account must be using [your own OAuth client](/connect/managed-auth/oauth-clients/#using-a-custom-oauth-client). You can only retrieve end user credentials for accounts that are using Pipedream's OAuth clients in `development`. [Learn more here](/connect/managed-auth/oauth-clients/#using-pipedream-oauth).
431
431
</Callout>
432
432
433
433
##### Examples
@@ -661,7 +661,7 @@ GET /{project_id}/accounts/{account_id}
@@ -680,7 +680,7 @@ Never return user credentials to the client
680
680
</Callout>
681
681
682
682
<Callouttype="info">
683
-
To retrieve the credentials for any account in `production` for OAuth apps (Slack, Google Sheets, etc), the connected account must be using [your own OAuth client](/connect/managed-auth/oauth-clients#using-a-custom-oauth-client). You can only retrieve end user credentials for accounts that are using Pipedream's OAuth clients in `development`. [Learn more here](/connect/managed-auth/oauth-clients#using-pipedream-oauth).
683
+
To retrieve the credentials for any account in `production` for OAuth apps (Slack, Google Sheets, etc), the connected account must be using [your own OAuth client](/connect/managed-auth/oauth-clients/#using-a-custom-oauth-client). You can only retrieve end user credentials for accounts that are using Pipedream's OAuth clients in `development`. [Learn more here](/connect/managed-auth/oauth-clients/#using-pipedream-oauth).
The app ID for which you want to delete all connected accounts. `app_id` can be `oauth_app_id` for [OAuth apps](/connect/managed-auth/quickstart#create-a-pipedream-oauth-client) or name slug for key-based apps, which you can find under the **Authentication** section of any [app page](https://pipedream.com/apps)
930
+
The app ID for which you want to delete all connected accounts. `app_id` can be `oauth_app_id` for [OAuth apps](/connect/managed-auth/quickstart/#create-a-pipedream-oauth-client) or name slug for key-based apps, which you can find under the **Authentication** section of any [app page](https://pipedream.com/apps)
0 commit comments