Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs-v2/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ export default withNextra({
DELAY_MIN_MAX_TIME:
"You can pause your workflow for as little as one millisecond, or as long as one year",
PUBLIC_APPS: "2,400",
REGISTRY_ACTIONS: "5,300",
REGISTRY_SOURCES: "2,500",
REGISTRY_COMPONENTS: "8,000",
FREE_INSPECTOR_EVENT_LIMIT: "7 days of events",
WARM_WORKERS_INTERVAL: "10 minutes",
WARM_WORKERS_CREDITS_PER_INTERVAL: "5",
Expand Down
6 changes: 3 additions & 3 deletions docs-v2/pages/_meta.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ export default {
"workspaces": "Workspaces",
"projects": "Projects",
"workflows": "Workflows",
"connect": {
title: "Pipedream Connect",
},
"code": "Code",
"data-stores": "Data Stores",
"databases": "Databases",
"connected-accounts": "Connected Accounts",
"apps": "Integrations",
"connect": {
title: "Pipedream Connect",
},
"components": "Components",
"sources": "Sources",
"event-history": "Event History",
Expand Down
2 changes: 1 addition & 1 deletion docs-v2/pages/connect/_meta.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export default {
"title": "Running workflows",
},
"components": {
"title": "Running components",
"title": "Embedding components",
},
"api": {
"title": "API & SDK reference",
Expand Down
19 changes: 18 additions & 1 deletion docs-v2/pages/connect/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,17 @@ The ID of your end user. Use whatever ID uniquely identifies the user in your sy

---

`allowed_origins` **string array**

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:

```json
{
"allowed_origins": ["http://localhost:3000", "https://example.com"]
}
```
---

`success_redirect_uri` **string** (_optional_)

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

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

const { token, expires_at } = await pd.createConnectToken({
external_user_id: "{your_external_user_id}", // The end user's ID in your system
allowed_origins: ["http://localhost:3000", "https://example.com"], // The allowed origins for the token (required for client-side requests)
});
```
</Tabs.Tab>
Expand All @@ -263,7 +276,11 @@ curl -X POST https://api.pipedream.com/v1/connect/{project_id}/tokens \
-H "X-PD-Environment: development" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{your_external_user_id}"
"external_user_id": "{your_external_user_id}",
"allowed_origins": [
"http://localhost:3000",
"https://example.com"
],
}'
```
</Tabs.Tab>
Expand Down
4 changes: 2 additions & 2 deletions docs-v2/pages/connect/components.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { Steps, Tabs } from 'nextra/components'
import Callout from '@/components/Callout'

# Running components for your end users
# Embedding components in your application

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

## What are components?
Expand Down
14 changes: 7 additions & 7 deletions docs-v2/pages/connect/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ You have full, code-level control over how these integrations work in your app.
Connect lets you:

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.
2. Securely retrieve OAuth access tokens, API keys, and other credentials for your end users with Pipedream's [REST API](/connect/api)
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.
4. [Embed any Pipedream action or trigger](/connect/components) to run on behalf of your users, directly from within your application.
2. Securely retrieve OAuth access tokens, API keys, and other credentials for your end users with Pipedream's [REST API](/connect/api).
3. [Embed any Pipedream action or trigger](/connect/components) to run on behalf of your users, directly from within your application.
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.

<br />

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

## Getting started

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

## App configuration for OAuth apps

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.

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).
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).

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

## Users

To view or delete your users' connected accounts:

1. Open your project
1. Open your project in Pipedream
2. Click the **Connect** tab on the left
3. Click the **Users** tab at the top

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)).

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

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.
</Callout>
Expand Down
2 changes: 1 addition & 1 deletion docs-v2/pages/connect/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If you're building your own app, you'll need to provide these values to the envi

### Create a project in Pipedream

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

### Create a Pipedream OAuth client
Expand Down
8 changes: 3 additions & 5 deletions docs-v2/pages/connect/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Image from 'next/image'

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**.

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

## What are workflows?

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

<Callout type="info">
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.
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.
</Callout>

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

<Callout type="info">
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.
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.
</Callout>

## Testing workflow steps
Expand Down
5 changes: 3 additions & 2 deletions docs-v2/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ import VideoPlayer from "@/components/VideoPlayer";

# Introduction to Pipedream

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

The Pipedream platform includes:

- A [serverless runtime](/code/) and [workflow service](/workflows/)
- Source-available [triggers](/workflows/steps/triggers/) and [actions](/workflows/steps/actions/) for [hundreds of integrated apps](https://pipedream.com/explore/)
- SDK to handle [customer authentication](/connect/) for {process.env.PUBLIC_APPS}+ APIs
- Source-available pre-built [triggers](/workflows/steps/triggers/) and [actions](/workflows/steps/actions/) for [thousands of integrated apps](https://pipedream.com/explore/)
- 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)

Watch a demo or review our [quickstart guide](/quickstart/):
Expand Down
Loading