Skip to content

Commit 63e8c66

Browse files
fix some broken links
1 parent e912c07 commit 63e8c66

File tree

98 files changed

+566
-577
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+566
-577
lines changed

docs-v2/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ We're moving from VuePress to Nextra. Here's what's the same and what's differen
2222
- New docs are here, in the `docs-v2/` directory.
2323
- All docs are still Markdown. Now MDX files instead of just Markdown, so extensions have been renamed to `.mdx`.
2424
- Keep images in `public/images/foo.png`, reference with `![alt text](/images/foo.png)`
25-
- Leaf nodes in VuePress were at files like `/docs/workspaces/sso/google/README.md`. Nextra allows leaf nodes to be non-index files like `/docs/workspaces/sso/google.mdx`, so there's no need for the final directory, which simplifies things.
25+
- Leaf nodes in VuePress were at files like `/docs/workflows/workspaces/sso/google/README.md`. Nextra allows leaf nodes to be non-index files like `/docs/workflows/workspaces/sso/google.mdx`, so there's no need for the final directory, which simplifies things.
2626
- VuePress used Vue, Nextra uses React. All of the custom components used in MDX files are either [built-in Nextra components](https://nextra.site/docs/guide/built-ins) or Pipedream-specific components in `components/`, ported from Vue.
2727
- Learn the [built-in Nextra components](https://nextra.site/docs/guide/built-ins). All the `::: tip`, `::: warning`, or other special VuePress components have an equivalent Nextra component.
2828

@@ -50,8 +50,8 @@ pages
5050
workspaces/
5151
index.mdx # /docs/workspaces
5252
sso/
53-
index.mdx # /docs/workspaces/sso
54-
google.mdx # /docs/workspaces/sso/google
53+
index.mdx # /docs/workflows/workspaces/sso
54+
google.mdx # /docs/workflows/workspaces/sso/google
5555
```
5656

5757
The `_meta.tsx` files in each directory defines a mapping between the labels in the sidebar and the files in that directory. If you want to add an item to the sidebar, you'll probably want to edit the `_meta.tsx` file. [See the Nextra docs](https://nextra.site/docs/docs-theme/page-configuration) for more info.

docs-v2/pages/account/billing-settings.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import Callout from '@/components/Callout'
22

33
# Billing Settings
44

5-
You'll find information on your usage data (for specific [Pipedream limits](/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](/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.
66

77
## Subscription
88

@@ -28,7 +28,7 @@ Users on the free tier will see the last 30 days of usage in this chart. Users o
2828

2929
Control the maximum number of compute credits permitted on your account with an _Credit Budget_.
3030

31-
This will restrict your account-wide usage to the specified number of [credits](/pricing/#credits) on a monthly or daily basis. The compute budget does not apply to credits incurred by [dedicated workers](/workflows/settings/#eliminate-cold-starts).
31+
This will restrict your account-wide usage to the specified number of [credits](/pricing/#credits) on a monthly or daily basis. The compute budget does not apply to credits incurred by [dedicated workers](/workflows/visual-builder/settings/#eliminate-cold-starts).
3232

3333
To enable this feature, _click_ on the toggle and define your maximum number of credits in the period.
3434

@@ -40,4 +40,4 @@ In an example scenario, with cap set at 20 credits and long running workflow tha
4040

4141
## Limits
4242

43-
For users on the [Free tier](/pricing/#free-tier), this section displays your usage towards your [credits quota](/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](/workflows/limits/#daily-credits-limit) for the current UTC day.

docs-v2/pages/account/user-settings.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Pipedream recommends enabling 2FA with your identity provider.
5050

5151
### Requiring 2-Factor Authentication
5252

53-
Workspaces on the Business plan can [require all workspace members to configure 2FA](/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](/workflows/workspaces/#requiring-two-factor-authentication) in order to log in to Pipedream.
5454

5555
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.
5656

@@ -62,7 +62,7 @@ Only workspace owner and admin members can enable or disable 2FA for an entire w
6262

6363
## Pipedream API Key
6464

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](/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](/workflows/rest-api/auth/).
6666

6767
You can revoke and regenerate your API key from here at any time.
6868

docs-v2/pages/connect/api-proxy.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ Before getting started with the Connect proxy, make sure you've already gone thr
2525

2626
## Getting started
2727

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](/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](/workflows/rest-api/connect/proxy).
2929

30-
- A [Pipedream OAuth client](/rest-api/auth#oauth) to make authenticated requests to Pipedream's API
30+
- A [Pipedream OAuth client](/workflows/rest-api/auth#oauth) to make authenticated requests to Pipedream's API
3131
- Connect [environment](/connect/environments) (ex, `production` or `development`)
3232
- The [external user ID](/connect/api#external-users) for your end user (ex, `abc-123`)
3333
- The [account ID](/connect/api#accounts) for your end user's connected account (ex, `apn_1234567`)
@@ -120,4 +120,4 @@ curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/proxy/{url_
120120
}'
121121

122122
# Parse and return the data you need
123-
```
123+
```

docs-v2/pages/connect/api.mdx

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ or a specific version:
4141

4242
## Authentication
4343

44-
See the [REST API Authentication docs](/rest-api/auth).
44+
See the [REST API Authentication docs](/workflows/rest-api/auth).
4545

4646
### TypeScript SDK (server)
4747

4848
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.
4949

50-
[Create a Pipedream OAuth client](/rest-api/auth#oauth) and instantiate the SDK with your client ID and secret:
50+
[Create a Pipedream OAuth client](/workflows/rest-api/auth#oauth) and instantiate the SDK with your client ID and secret:
5151

5252
```typescript
5353
import { createBackendClient } from "@pipedream/sdk/server";
@@ -206,7 +206,7 @@ curl -X POST https://api.pipedream.com/v1/connect/rate_limits \
206206
**Example usage**
207207

208208
```bash
209-
# The response will include a rate limit token.
209+
# The response will include a rate limit token.
210210
# Pass it as a header in your downstream requests to the Connect API.
211211
# Below is an example request that runs the "List Commits" action for the Gitlab app.
212212

@@ -1120,7 +1120,7 @@ apps](/rest-api#list-apps) endpoint, and the name slug under the
11201120
`q` **string** (_optional_)
11211121

11221122
A search query to filter the components by key (see the [component structure
1123-
table](/components/api#component-structure)).
1123+
table](/workflows/contributing/components/api#component-structure)).
11241124

11251125
##### Examples
11261126

@@ -1257,7 +1257,7 @@ Either `triggers`, `actions`, or `components`.
12571257
`component_key` **string**
12581258

12591259
The key that identifies the component (see the [component structure
1260-
table](/components/api#component-structure)).
1260+
table](/workflows/contributing/components/api#component-structure)).
12611261

12621262
##### Examples
12631263

@@ -1414,7 +1414,7 @@ want to retrieve accounts for.
14141414
`id` **string**
14151415

14161416
The key that identifies the component (see the [component structure
1417-
table](/components/api#component-structure)).
1417+
table](/workflows/contributing/components/api#component-structure)).
14181418

14191419
---
14201420

@@ -1597,7 +1597,7 @@ Reload the component's props after configuring a dynamic prop, based on the
15971597
current component's configuration. This endpoint will use the component's
15981598
configuration to retrieve a new list of props depending on the value of the
15991599
props that were configured so far. See the [Dynamic
1600-
Props](/connect/components#dynamic-props-optional) section for more information.
1600+
Props](/connect/workflows/contributing/components#dynamic-props-optional) section for more information.
16011601

16021602
```text
16031603
GET /{component_type}/props
@@ -1629,7 +1629,7 @@ want to retrieve accounts for.
16291629
`id` **string**
16301630

16311631
The key that identifies the component (see the [component structure
1632-
table](/components/api#component-structure)).
1632+
table](/workflows/contributing/components/api#component-structure)).
16331633

16341634
---
16351635

@@ -1832,7 +1832,7 @@ POST /actions/run
18321832
`id` **string**
18331833

18341834
The key that identifies the action component (see the [component structure
1835-
table](/components/api#component-structure)).
1835+
table](/workflows/contributing/components/api#component-structure)).
18361836

18371837
---
18381838

@@ -2021,7 +2021,7 @@ POST /triggers/deploy
20212021
`id` **string**
20222022

20232023
The key that identifies the action component (see the [component structure
2024-
table](/components/api#component-structure)).
2024+
table](/workflows/contributing/components/api#component-structure)).
20252025

20262026
---
20272027

@@ -3500,4 +3500,3 @@ curl -X PUT \
35003500
]
35013501
}
35023502
```
3503-

docs-v2/pages/connect/components.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Here's the response:
150150
To configure and run a component for your end users, you need to understand
151151
the component's definition. Now that you have the component's key from the previous step,
152152
you can retrieve its structure from the Pipedream API. See the [component
153-
structure](/components/api#component-structure) section in our docs for more
153+
structure](/workflows/contributing/components/api#component-structure) section in our docs for more
154154
details.
155155

156156
As an example, the following API call will return the structure of the **List
@@ -162,7 +162,7 @@ GET /v1/connect/components/gitlab-list-commits
162162

163163
The response will contain the component's structure, including its user-friendly name,
164164
version, and most importantly, the configuration options the component accepts
165-
(also known as [props](/components/api#props) or "properties").
165+
(also known as [props](/workflows/contributing/components/api#props) or "properties").
166166
Here's an example of the response for the component in the example above:
167167

168168
```json
@@ -346,7 +346,7 @@ For example, to retrieve the configuration options for the `refName` prop:
346346

347347
The set of props that a component can accept might not be static, and may change
348348
depending on the values of prior props. Props that behave this way are called
349-
[dynamic props](/components/api#dynamic-props), and they need to be configured
349+
[dynamic props](/workflows/contributing/components/api#dynamic-props), and they need to be configured
350350
in a different way. Props that are dynamic will have a `reloadProps` attribute
351351
set to `true` in the component's code.
352352

@@ -447,8 +447,8 @@ To illustrate, the response for the request above would look like this:
447447
### Execution
448448

449449
Once all the props have been configured, the component can be invoked. Pipedream
450-
supports two types of components: [actions](/components#actions) and
451-
[sources](/components#sources) (aka triggers).
450+
supports two types of components: [actions](/workflows/contributing/components/api#actions) and
451+
[sources](/workflows/contributing/components/api#sources) (aka triggers).
452452

453453
Actions are components that perform a task by taking an input either during
454454
[configuration](#configure-the-component) and/or during invocation (usually both), and
@@ -495,7 +495,7 @@ The output of executing the action will be a JSON object containing the
495495
following fields:
496496

497497
1. `exports`: all the named exports produced by the action, like when calling
498-
[`$.export` in a Node.js](/code/nodejs#using-export) component.
498+
[`$.export` in a Node.js](/workflows/visual-builder/code/nodejs#using-export) component.
499499
2. `os`: a list of observations produced by the action (e.g. logs, errors, etc).
500500
3. `ret`: the return value of the action, if any.
501501

docs-v2/pages/connect/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import VideoPlayer from "@/components/VideoPlayer";
55

66
# Pipedream Connect
77

8-
**Connect provides a developer toolkit that lets you add {process.env.PUBLIC_APPS}+ integrations to your app or AI agent.** You can build AI agents, in-app messaging, CRM syncs, [and much more](/connect/use-cases), all in a few minutes. You have full, code-level control over how these integrations work in your app. You handle your product, Pipedream simplifies the integration.
8+
**Connect provides a developer toolkit that lets you add {process.env.PUBLIC_APPS}+ integrations to your app or AI agent.** You can build AI agents, in-app messaging, CRM syncs, [and much more](/connect/use-cases), all in a few minutes. You have full, code-level control over how these integrations work in your app. You handle your product, Pipedream simplifies the integration.
99

1010
![Connect visualization](https://res.cloudinary.com/pipedreamin/image/upload/v1738731467/pd-connect-viz_cep0uq.png)
1111

@@ -64,5 +64,5 @@ All credentials and tokens are sent to Pipedream securely over HTTPS, and encryp
6464
- **App**: GitHub, Notion, Slack, Google Sheets, and more. The app is the API you want your users to connect to in your product. See the [full list here](https://pipedream.com/apps).
6565
- **Developer**: This is probably you, the Pipedream customer who's developing an app and wants to use Connect to make API requests on behalf of your end users.
6666
- **End User**: Your customer or user, whose data you want to access on their behalf. End users are identifed via the `external_user_id` param in the Connect SDK and API.
67-
- **Connected Account**: The account your end user connects. [Read more about connected accounts](/connected-accounts).
68-
- **OAuth Client**: This is admittedly a bit of an overloaded term and refers both to [custom OAuth clients](/connect/managed-auth/oauth-clients) you create in Pipedream to use when your end users authorize access to their account, as well as [OAuth clients to authenticate to Pipedream's API](/rest-api/auth#oauth).
67+
- **Connected Account**: The account your end user connects. [Read more about connected accounts](/workflows/integrations/connected-accounts).
68+
- **OAuth Client**: This is admittedly a bit of an overloaded term and refers both to [custom OAuth clients](/connect/managed-auth/oauth-clients) you create in Pipedream to use when your end users authorize access to their account, as well as [OAuth clients to authenticate to Pipedream's API](/workflows/rest-api/auth#oauth).

docs-v2/pages/connect/managed-auth/oauth-clients.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import Callout from '@/components/Callout'
33

44
# OAuth Clients
55

6-
When connecting an account for any OAuth app via Pipedream Connect, we'll default to using Pipedream's official OAuth client, which enables you to quickly get up and running. [Read more about OAuth clients in Pipedream here](/connected-accounts/oauth-clients).
6+
When connecting an account for any OAuth app via Pipedream Connect, we'll default to using Pipedream's official OAuth client, which enables you to quickly get up and running. [Read more about OAuth clients in Pipedream here](/workflows/integrations/connected-accounts/oauth-clients).
77

88
## Using Pipedream OAuth
99

@@ -28,7 +28,7 @@ For any OAuth app that supports it, **you can always use your own client.** Your
2828

2929
## Using a custom OAuth client
3030

31-
1. Follow the steps [here](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) to create an OAuth client in Pipedream.
31+
1. Follow the steps [here](/workflows/integrations/connected-accounts/oauth-clients#configuring-custom-oauth-clients) to create an OAuth client in Pipedream.
3232
2. When connecting an account either via the [frontend SDK](/connect/managed-auth/quickstart#use-the-pipedream-sdk-in-your-frontend), make sure to include the `oauthAppId` in `pd.connectAccount()`.
3333
3. If using [Connect Link](/connect/managed-auth/quickstart#or-use-connect-link), make sure to include the `oauthAppId` in the URL.
3434

@@ -38,4 +38,4 @@ For any OAuth app that supports it, **you can always use your own client.** Your
3838

3939
<br />
4040

41-
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1730241292/oauth-app-id_umhhqi.png" alt="Copy OAuth App ID" width={650} height={529} />
41+
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1730241292/oauth-app-id_umhhqi.png" alt="Copy OAuth App ID" width={650} height={529} />

docs-v2/pages/connect/migrating-from-project-keys-to-oauth.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This guide is only relevant if:
1212

1313
## What changed
1414

15-
- In the `0.x` version of the SDK and the original Connect API, you could authenticate with keys scoped to a specific project. In the `1.x` version of the SDK, you need to authenticate with [OAuth clients](/rest-api/auth#oauth).
15+
- In the `0.x` version of the SDK and the original Connect API, you could authenticate with keys scoped to a specific project. In the `1.x` version of the SDK, you need to authenticate with [OAuth clients](/workflows/rest-api/auth#oauth).
1616
- The `createClient` method from both the browser and Node.js SDKs has been replaced with separate methods: `createFrontendClient` and `createBackendClient`, respectively.
1717
- The `connectTokenCreate` method has been renamed `createConnectToken`
1818
- New SDK methods: `projectInfo`, `invokeWorkflow`, and more
@@ -23,7 +23,7 @@ This guide is only relevant if:
2323

2424
### Create an OAuth client
2525

26-
Follow the instructions [here](/rest-api/auth#oauth) to create an OAuth client.
26+
Follow the instructions [here](/workflows/rest-api/auth#oauth) to create an OAuth client.
2727

2828
### Update your SDK version
2929

@@ -75,7 +75,7 @@ You'll need to make three changes to your backend code:
7575
<Tabs.Tab>
7676
```typescript
7777
import { createBackendClient, HTTPAuthType } from "@pipedream/sdk/server";
78-
78+
7979
// These secrets should be saved securely and passed to your environment
8080
const pd = createBackendClient({
8181
credentials: {
@@ -100,4 +100,4 @@ const pd = createBackendClient({
100100
</Tabs.Tab>
101101
</Tabs>
102102

103-
</Steps>
103+
</Steps>

docs-v2/pages/connect/use-cases.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Sync data between your app and Salesforce, HubSpot, or any CRM. Pipedream lets y
3030

3131
### AI products
3232

33-
Talk to any AI API or LLM. Build chat apps or interact in real-time with your users. Or run asynchronous tasks in the background, like image classification, article summarization, or other tasks you want to offload to an AI agent. You can use built-in functions like [`$.flow.suspend`](/code/nodejs/rerun#flowsuspend) to send a message to your team, or directly to the user, to approve specific actions.
33+
Talk to any AI API or LLM. Build chat apps or interact in real-time with your users. Or run asynchronous tasks in the background, like image classification, article summarization, or other tasks you want to offload to an AI agent. You can use built-in functions like [`$.flow.suspend`](/workflows/visual-builder/code/nodejs/rerun#flowsuspend) to send a message to your team, or directly to the user, to approve specific actions.
3434

3535
### Spreadsheet integrations
3636

0 commit comments

Comments
 (0)