Skip to content

Commit 21bddc4

Browse files
Danny/connect docs update (#15323)
* Small updates to Connect docs * Adding allowed_origins to createConnectToken docs * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent 84541ad commit 21bddc4

File tree

9 files changed

+41
-22
lines changed

9 files changed

+41
-22
lines changed

docs-v2/next.config.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ export default withNextra({
5151
DELAY_MIN_MAX_TIME:
5252
"You can pause your workflow for as little as one millisecond, or as long as one year",
5353
PUBLIC_APPS: "2,400",
54+
REGISTRY_ACTIONS: "5,300",
55+
REGISTRY_SOURCES: "2,500",
56+
REGISTRY_COMPONENTS: "8,000",
5457
FREE_INSPECTOR_EVENT_LIMIT: "7 days of events",
5558
WARM_WORKERS_INTERVAL: "10 minutes",
5659
WARM_WORKERS_CREDITS_PER_INTERVAL: "5",

docs-v2/pages/_meta.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ export default {
44
"workspaces": "Workspaces",
55
"projects": "Projects",
66
"workflows": "Workflows",
7+
"connect": {
8+
title: "Pipedream Connect",
9+
},
710
"code": "Code",
811
"data-stores": "Data Stores",
912
"databases": "Databases",
1013
"connected-accounts": "Connected Accounts",
1114
"apps": "Integrations",
12-
"connect": {
13-
title: "Pipedream Connect",
14-
},
1515
"components": "Components",
1616
"sources": "Sources",
1717
"event-history": "Event History",

docs-v2/pages/connect/_meta.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export default {
1212
"title": "Running workflows",
1313
},
1414
"components": {
15-
"title": "Running components",
15+
"title": "Embedding components",
1616
},
1717
"api": {
1818
"title": "API & SDK reference",

docs-v2/pages/connect/api.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,17 @@ The ID of your end user. Use whatever ID uniquely identifies the user in your sy
181181

182182
---
183183

184+
`allowed_origins` **string array**
185+
186+
When using the Connect API to make requests from a client environment like a browser, you must specify the allowed origins for the token. Otherwise, this field is optional. This is a list of URLs that are allowed to make requests with the token. For example:
187+
188+
```json
189+
{
190+
"allowed_origins": ["http://localhost:3000", "https://example.com"]
191+
}
192+
```
193+
---
194+
184195
`success_redirect_uri` **string** (_optional_)
185196

186197
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.
@@ -224,6 +235,7 @@ const pd = createBackendClient({
224235

225236
const { token, expires_at } = await pd.createConnectToken({
226237
external_user_id: "{your_external_user_id}" // The end user's ID in your system
238+
allowed_origins: ["http://localhost:3000", "https://example.com"], // The allowed origins for the token (required for client-side requests)
227239
});
228240
```
229241
</Tabs.Tab>
@@ -242,6 +254,7 @@ const pd = createBackendClient({
242254

243255
const { token, expires_at } = await pd.createConnectToken({
244256
external_user_id: "{your_external_user_id}", // The end user's ID in your system
257+
allowed_origins: ["http://localhost:3000", "https://example.com"], // The allowed origins for the token (required for client-side requests)
245258
});
246259
```
247260
</Tabs.Tab>
@@ -263,7 +276,11 @@ curl -X POST https://api.pipedream.com/v1/connect/{project_id}/tokens \
263276
-H "X-PD-Environment: development" \
264277
-H "Authorization: Bearer {access_token}" \
265278
-d '{
266-
"external_user_id": "{your_external_user_id}"
279+
"external_user_id": "{your_external_user_id}",
280+
"allowed_origins": [
281+
"http://localhost:3000",
282+
"https://example.com"
283+
],
267284
}'
268285
```
269286
</Tabs.Tab>

docs-v2/pages/connect/components.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import { Steps, Tabs } from 'nextra/components'
22
import Callout from '@/components/Callout'
33

4-
# Running components for your end users
4+
# Embedding components in your application
55

66
Pipedream Connect provides APIs to embed [pre-built components](/components) directly in your application
7-
or AI agent, unlocking access to thousands of pre-built API operations. Enable [your end users](/connect/api#external-users) to
7+
or AI agent, unlocking access to {process.env.REGISTRY_COMPONENTS}+ pre-built API operations. Enable [your end users](/connect/api#external-users) to
88
configure, deploy, and invoke Pipedream triggers and actions for more than {process.env.PUBLIC_APPS} APIs.
99

1010
## What are components?

docs-v2/pages/connect/index.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ You have full, code-level control over how these integrations work in your app.
1212
Connect lets you:
1313

1414
1. Handle authorization or accept API keys on behalf of your users, for any of Pipedream's [{process.env.PUBLIC_APPS}+ APIs](https://pipedream.com/apps). Use the [Client SDK](https://github.com/PipedreamHQ/pipedream/tree/master/packages/sdk) or [Connect Link](/connect/quickstart#or-use-connect-link) to accept auth in minutes.
15-
2. Securely retrieve OAuth access tokens, API keys, and other credentials for your end users with Pipedream's [REST API](/connect/api)
16-
3. [Run workflows](/connect/workflows) for your end users with Pipedream's [workflow builder](/workflows), [serverless runtime](/), and thousands of no-code [triggers](/workflows/triggers) and [actions](/workflows/actions). Build complex integrations in minutes, writing code when you need it and using no-code components when you don't. Pipedream workflows are easy to modify, debug, and scale.
17-
4. [Embed any Pipedream action or trigger](/connect/components) to run on behalf of your users, directly from within your application.
15+
2. Securely retrieve OAuth access tokens, API keys, and other credentials for your end users with Pipedream's [REST API](/connect/api).
16+
3. [Embed any Pipedream action or trigger](/connect/components) to run on behalf of your users, directly from within your application.
17+
4. [Run workflows](/connect/workflows) for your end users with Pipedream's [workflow builder](/workflows), [serverless runtime](/), and thousands of no-code [triggers](/workflows/triggers) and [actions](/workflows/actions). Build complex integrations in minutes, writing code when you need it and using no-code components when you don't. Pipedream workflows are easy to modify, debug, and scale.
1818

1919
<br />
2020

@@ -33,28 +33,28 @@ Pipedream Connect lets you build any API integration into your product in minute
3333

3434
## Getting started
3535

36-
Watch [the demo](https://www.youtube.com/embed/xhUagMsogkQ) or visit [the quickstart](/connect/quickstart) to build your first integration.
36+
Visit [the managed auth quickstart](/connect/quickstart) to build your first integration.
3737

3838
## App configuration for OAuth apps
3939

4040
Pipedream has more than {process.env.PUBLIC_APPS} apps available for you to integrate via Connect. Getting started is easy — just follow the [quickstart](/connect/quickstart) to get up and running.
4141

42-
By default, apps that use OAuth to authenticate will use Pipedream's official OAuth client. To deploy your integrations to production, you'll need to configure your own OAuth client. Read more about OAuth clients in Pipedream [here](/connected-accounts/oauth-clients).
42+
By default, apps that use OAuth to authenticate will use Pipedream's OAuth client. Depending on your use case, you may need to configure your own OAuth client. Read more about OAuth clients in Pipedream [here](/connected-accounts/oauth-clients).
4343

4444
[Let us know](https://pipedream.com/support) if the app you're looking for isn't listed [here](https://pipedream.com/apps).
4545

4646
## Users
4747

4848
To view or delete your users' connected accounts:
4949

50-
1. Open your project
50+
1. Open your project in Pipedream
5151
2. Click the **Connect** tab on the left
5252
3. Click the **Users** tab at the top
5353

5454
You'll see a list of all users, their connected accounts, and the option to delete any accounts from the UI. You can also retrieve and delete all your users via the API ([see the docs for reference](/connect/api)).
5555

5656
<Callout type="warning">
57-
Connect currently supports one connected account per user / app / environment combination.
57+
Connect currently supports one connected account per user, app, environment combination.
5858

5959
So if user `abc-123` in your application connects their Slack account in `production`, then that same user connects a different Slack workspace (also in `production`), the first connected account will get overwritten in Pipedream and replaced by the second.
6060
</Callout>

docs-v2/pages/connect/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If you're building your own app, you'll need to provide these values to the envi
5757

5858
### Create a project in Pipedream
5959

60-
1. Open an existing Pipedream project or create a new one at [https://pipedream.com/projects](https://pipedream.com/projects).
60+
1. Open an existing Pipedream project or create a new one at [pipedream.com/projects](https://pipedream.com/projects).
6161
2. Click the **Settings** tab, then copy your **Project ID**.
6262

6363
### Create a Pipedream OAuth client

docs-v2/pages/connect/workflows.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import Image from 'next/image'
77

88
Just like you can build and run internal [workflows](/workflows/) for your team, **you can run workflows for [your end users](/connect/api#external-users), too**.
99

10-
Whether you're building well-defined integrations or more-autonomous AI agents, workflows provide a powerful set of tools for running [code](/code) or [pre-defined actions](/workflows/actions) on behalf of your users. Pipedream's UI makes it easy to build, test, and [debug](/workflows/inspect) workflows.
10+
Whether you're building well-defined integrations or autonomous AI agents, workflows provide a powerful set of tools for running [code](/code) or [pre-defined actions](/workflows/actions) on behalf of your users. Pipedream's UI makes it easy to build, test, and [debug](/workflows/inspect) workflows.
1111

1212
## What are workflows?
1313

@@ -44,9 +44,7 @@ Read [the quickstart](/quickstart/) to learn more.
4444
2. [Configure **OAuth** authorization](/workflows/triggers#oauth) on the trigger.
4545

4646
<Callout type="info">
47-
To securely run workflows for end users, **configuring OAuth authorization on the trigger is optional but strongly recommended.**
48-
49-
[Create a Pipedream OAuth client](/rest-api/auth#creating-an-oauth-client) to authenticate requests to the Pipedream API and workflows.
47+
To securely run workflows for end users, **configuring OAuth authorization on the trigger is optional but strongly recommended.** [Create a Pipedream OAuth client](/rest-api/auth#creating-an-oauth-client) to authenticate requests to the Pipedream API and workflows.
5048
</Callout>
5149

5250
### Configure accounts to use your end users' auth
@@ -234,7 +232,7 @@ curl -X POST https://{your-endpoint-url} \
234232
</div>
235233

236234
<Callout type="info">
237-
We plan to improve this interface in the future, and potentially allow developers to store end user metadata and configuration data alongside the connected account for your end users, so you won't need to pass the data at runtime.
235+
We plan to improve this interface in the future, and potentially allow developers to store end user metadata and configuration data alongside the connected account for your end users, so you won't need to pass the data at runtime. [Let us know](https://pipedream.com/support) if that's a feature you'd like to see.
238236
</Callout>
239237

240238
## Testing workflow steps

docs-v2/pages/index.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@ import VideoPlayer from "@/components/VideoPlayer";
22

33
# Introduction to Pipedream
44

5-
Pipedream is the fastest way to automate any process that connects APIs. Build and run workflows with code-level control when you need it, and no code when you don't.
5+
Pipedream is the fastest way to automate any process that connects APIs. Build and run workflows with code-level control when you need it, and no code when you don't. Easily add thousands of customer-facing integrations to your app or AI agent in minutes.
66

77
The Pipedream platform includes:
88

99
- A [serverless runtime](/code/) and [workflow service](/workflows/)
10-
- Source-available [triggers](/workflows/steps/triggers/) and [actions](/workflows/steps/actions/) for [hundreds of integrated apps](https://pipedream.com/explore/)
10+
- SDK to handle [customer authentication](/connect/) for {process.env.PUBLIC_APPS}+ APIs
11+
- Source-available pre-built [triggers](/workflows/steps/triggers/) and [actions](/workflows/steps/actions/) for [thousands of integrated apps](https://pipedream.com/explore/)
1112
- One-click [OAuth and key-based authentication](/connected-accounts/) for more than {process.env.PUBLIC_APPS} APIs (use tokens directly in code or with pre-built actions)
1213

1314
Watch a demo or review our [quickstart guide](/quickstart/):

0 commit comments

Comments
 (0)