Skip to content

Commit 1eeebea

Browse files
dannyrooseveltdannyroosevelt
committed
More progress, still WIP
1 parent d474c8f commit 1eeebea

File tree

4 files changed

+34
-36
lines changed

4 files changed

+34
-36
lines changed

‎docs-v2/pages/connect/index.mdx‎

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

66
# Pipedream Connect
77

8-
Pipedream Connect is the easiest way for your users to connect to [over {process.env.PUBLIC_APPS}+ APIs](https://pipedream.com/apps), **right in your product**. You can build in-app messaging, CRM syncs, AI agents, [and much more](/connect/use-cases), all in a few minutes. Visit [the quickstart](/connect/quickstart) to build your first 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

10-
You have full, code-level control over how these integrations work in your app. You handle your product, Pipedream simplifies the integration.
10+
## Use managed auth
1111

12-
Connect lets you:
12+
- 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)
13+
- 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
14+
- Ship new integrations quickly by using Pipedream's approved OAuth clients
1315

14-
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. [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.
1816

19-
<br />
17+
## Act on behalf of your users
2018

21-
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1724194758/Screenshot_2024-08-20_at_3.59.05_PM_rfylfq.png" alt="Pipedream Connect overview" width={800} height={529} />
19+
- Retrieve OAuth access tokens and API keys for your end users with Pipedream's [REST API](/connect/api)
20+
- Add 10k pre-built tools and triggers from {process.env.PUBLIC_APPS}+ APIs to your AI agent or embed them directly in your SaaS app
21+
- Develop and deploy complex multi-step [workflows](/connect/workflows) in our [visual workflow builder](/workflows)
22+
- Use the Connect proxy to make custom API requests
23+
24+
{/* <Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1724194758/Screenshot_2024-08-20_at_3.59.05_PM_rfylfq.png" alt="Pipedream Connect overview" width={800} height={529} /> */}
2225

2326
## Use cases
2427

2528
Pipedream Connect lets you build any API integration into your product in minutes. Our customers build:
2629

30+
- **AI products**: Talk to any AI API or LLM, interacting with your users or running AI-driven asynchronous tasks
2731
- **In-app messaging**: Send messages to Slack, Discord, Microsoft Teams, or any app directly from your product.
2832
- **CRM syncs**: Sync data between your app and Salesforce, HubSpot, or any CRM
29-
- **AI products**: Talk to any AI API or LLM, interacting with your users or running AI-driven asynchronous tasks
3033
- **Spreadsheet integrations**: Sync data between your app and Google Sheets, Airtable, or any spreadsheet
3134

3235
[and much more](/connect/use-cases).
@@ -35,33 +38,9 @@ Pipedream Connect lets you build any API integration into your product in minute
3538

3639
Visit [the managed auth quickstart](/connect/quickstart) to build your first integration.
3740

38-
## App configuration for OAuth apps
39-
40-
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.
41-
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).
43-
44-
[Let us know](https://pipedream.com/support) if the app you're looking for isn't listed [here](https://pipedream.com/apps).
45-
46-
## Users
47-
48-
To view or delete your users' connected accounts:
49-
50-
1. Open your project in Pipedream
51-
2. Click the **Connect** tab on the left
52-
3. Click the **Users** tab at the top
53-
54-
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)).
55-
56-
<Callout type="warning">
57-
Connect currently supports one connected account per user, app, environment combination.
58-
59-
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.
60-
</Callout>
61-
6241
## Plans and pricing
6342

64-
**Managed authentication with Connect is free to use for up to 1,000 connected accounts for any workspace**. Check out our [pricing page](https://pipedream.com/pricing?plan=Enterprise) for details on running workflows and embedding components in your app.
43+
**Managed authentication with Connect is free to use for up to 1,000 connected accounts for any workspace**. Check out our [pricing page](https://pipedream.com/pricing?plan=Enterprise) to get in touch with our Sales team for details on using Connect in production.
6544

6645
## Security
6746

@@ -84,4 +63,4 @@ All credentials and tokens are sent to Pipedream securely over HTTPS, and encryp
8463
- **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.
8564
- **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.
8665
- **Connected Account**: The account your end user connects. [Read more about connected accounts](/connected-accounts).
87-
- **OAuth Client**: Custom OAuth clients you create in Pipedream. [Read more about OAuth clients](/connected-accounts/oauth-clients).
66+
- **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).

‎docs-v2/pages/connect/managed-auth/_meta.tsx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
export default {
22
"index": "Overview",
3+
"users": "Users",
34
"quickstart": "Quickstart",
45
"tokens": "Connect Tokens",
56
"connect-link": "Connect Link",

‎docs-v2/pages/connect/managed-auth/users.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import Callout from '@/components/Callout'
2+
3+
# Users
4+
5+
To view or delete your users' connected accounts:
6+
7+
1. Open your project in Pipedream
8+
2. Click the **Connect** tab on the left
9+
3. Click the **Users** tab at the top
10+
11+
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)).
12+
13+
<Callout type="warning">
14+
Connect currently supports one connected account per user, app, environment combination.
15+
16+
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.
17+
</Callout>

‎docs-v2/pages/rest-api/auth.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ const pd = createBackendClient({
4040
clientId: "YOUR_CLIENT_ID",
4141
clientSecret: "YOUR_CLIENT_SECRET",
4242
},
43+
projectId: "YOUR_PROJECT_ID", // This is typically required for most Connect API endpoints
4344
});
4445

4546
// Use the SDK's helper methods to make requests

0 commit comments

Comments
 (0)