diff --git a/docs-v2/next.config.mjs b/docs-v2/next.config.mjs index 99c7af289d5ba..06480a838ab3a 100644 --- a/docs-v2/next.config.mjs +++ b/docs-v2/next.config.mjs @@ -50,7 +50,7 @@ export default withNextra({ TMP_SIZE_LIMIT: "2GB", 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", + PUBLIC_APPS: "2,500", REGISTRY_ACTIONS: "5,300", REGISTRY_SOURCES: "2,500", REGISTRY_COMPONENTS: "8,000", diff --git a/docs-v2/pages/_meta.tsx b/docs-v2/pages/_meta.tsx index 4a817bb34cdb3..42ddc6480d3f1 100644 --- a/docs-v2/pages/_meta.tsx +++ b/docs-v2/pages/_meta.tsx @@ -5,7 +5,7 @@ export default { "projects": "Projects", "workflows": "Workflows", "connect": { - title: "Pipedream Connect", + title: "Connect", }, "code": "Code", "data-stores": "Data Stores", diff --git a/docs-v2/pages/connect/_meta.tsx b/docs-v2/pages/connect/_meta.tsx index 1ba883bb056b5..a53b7c0718ea4 100644 --- a/docs-v2/pages/connect/_meta.tsx +++ b/docs-v2/pages/connect/_meta.tsx @@ -5,35 +5,23 @@ export default { "use-cases": { "title": "Use cases", }, - "quickstart": { + "managed-auth": { "title": "Managed auth", }, - "workflows": { - "title": "Running workflows", - }, "components": { - "title": "Embedding components", + "title": "Pre-built tools", }, - "api": { - "title": "API & SDK reference", + "api-proxy": { + "title": "API proxy", }, - "tokens": { - "title": "Connect tokens", + "workflows": { + "title": "Workflows", }, "environments": { "title": "Environments", }, - "oauth-clients": { - "title": "OAuth clients", - }, - "webhooks": { - "title": "Webhooks", - }, - "connect-link": { - "title": "Connect Link", - }, - "customize-your-app": { - "title": "Customize your app", + "api": { + "title": "API & SDK reference", }, "troubleshooting": { "title": "Troubleshooting", diff --git a/docs-v2/pages/connect/api-proxy.mdx b/docs-v2/pages/connect/api-proxy.mdx new file mode 100644 index 0000000000000..654aeba7a5c04 --- /dev/null +++ b/docs-v2/pages/connect/api-proxy.mdx @@ -0,0 +1,123 @@ +import { Tabs } from 'nextra/components' +import Callout from '@/components/Callout' + +# Connect API Proxy + +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: + +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) +2. There isn't a [pre-built tool](/connect/components) (action) for the app, or you need to modify the request +3. You want to avoid storing end user credentials in your app + +## Overview + +The Connect proxy enables you to interface with any integrated API and make authenticated requests on behalf of your users, without dealing with OAuth or storing end user credentials. + +1. You send a request to the proxy and identify the end user you want to act on behalf of +2. The proxy sends the request to the downstream API and dynamically inserts your end user's auth credentials +3. The proxy returns the response from the downstream API back to you + +![Connect API proxy visualization](https://res.cloudinary.com/pipedreamin/image/upload/v1738822030/pd-connect-proxy-viz_k5iksb.png) + + +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. + + +## Getting started + +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). + +- A [Pipedream OAuth client](/rest-api/auth#oauth) to make authenticated requests to Pipedream's API +- Connect [environment](/connect/environments) (ex, `production` or `development`) +- The [external user ID](/connect/api#external-users) for your end user (ex, `abc-123`) +- The [account ID](/connect/api#accounts) for your end user's connected account (ex, `apn_1234567`) + +Refer to the full Connect API [here](/connect/api). + +### Using the Pipedream SDK (preferred) + +You can use the [Pipedream SDK](https://www.npmjs.com/package/@pipedream/sdk) to send a fetch-style request: + +```javascript +import { createBackendClient } from "@pipedream/sdk/server"; + +const pd = createBackendClient({ + environment: {development | production}, + projectId: {your_projectId}, + credentials: { + clientId: {your_oauth_client_id}, + clientSecret: {your_oauth_client_secret} + }, +}); + + +const resp = await pd.makeProxyRequest( + { + searchParams: { + account_id: "{account_id}", // The account ID for your end user (ex, apn_1234567) + external_user_id: "{external_user_id}", // The external user ID for your end user + } + }, + { + url: "https://slack.com/api/chat.postMessage", // Include any query params you need; no need to Base64 encode the URL if using the SDK + options: { + method: "POST", + headers: { + hello: "world!" // These get sent to the downstream API + }, + body: { + text: "hello, world", + channel: "C03NA8B4VA9" + }, + }, + } +) + +// Parse and return the data you need +console.log(resp); +``` + +### Using the REST API + +You can also send a request to the Connect REST API with the below config: + +**URL** + +- The URL of the API you want to call (ex, `https://slack.com/api/chat.postMessage`) +- When using the REST API, this should be an URL-safe Base64 encoded string (ex, `aHR0cHM6Ly9zbGFjay5jb20vYXBpL2NoYXQucG9zdE1lc3NhZ2U`) + +**HTTP method** + +- Use the HTTP method required by the downstream API + +**Body** + +- Optionally include a body to send to the downstream API + +**Headers** + +- If using the REST API, include the `Authorization` header with your Pipedream OAuth access token (`Bearer {access_token}`) +- Headers that contain the prefix `x-pd-proxy` will get forwarded to the downstream API + +```bash +# First, obtain an OAuth access token +curl -X POST https://api.pipedream.com/v1/oauth/token \ + -H "Content-Type: application/json" \ + -d '{ + "grant_type": "client_credentials", + "client_id": "{your_oauth_client_id}", + "client_secret": "{your_oauth_client_secret}" + }' + +# The response will include an access_token. Use it in the Authorization header below. + +curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/proxy/{url_safe_base64_encoded_url}?external_user_id={external_user_id}&account_id={apn_xxxxxxx}" \ + -H "Authorization: Bearer {access_token}" \ + -H "x-pd-environment: {development | production}" \ + -d '{ + "text": "hello, world", + "channel": "C03NA8B4VA9" + }' + +# Parse and return the data you need +``` \ No newline at end of file diff --git a/docs-v2/pages/connect/api.mdx b/docs-v2/pages/connect/api.mdx index b2b2bca20afbe..b29f526de8d09 100644 --- a/docs-v2/pages/connect/api.mdx +++ b/docs-v2/pages/connect/api.mdx @@ -70,7 +70,7 @@ You'll primarily use the browser SDK to let your users securely connect apps fro 1. [Create a short-lived token on your server](#create-a-new-token) 2. Initiate auth with that token to securely connect an account for a specific user -Here's a Next.js example [from our quickstart](/connect/quickstart): +Here's a Next.js example [from our quickstart](/connect/managed-auth/quickstart): ```typescript import { createFrontendClient } from "@pipedream/sdk/browser" @@ -408,7 +408,7 @@ You can find the app's ID in the response from the [List apps](/rest-api#list-ap `oauth_app_id` **string** (_optional_) -The ID of the [OAuth app](/connect/quickstart#create-a-pipedream-oauth-client) you'd like to retrieve accounts for. +The ID of the [OAuth app](/connect/managed-auth/quickstart#create-a-pipedream-oauth-client) you'd like to retrieve accounts for. --- @@ -427,7 +427,7 @@ Never return user credentials to the client -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/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/oauth-clients#using-pipedream-oauth). +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). ##### Examples @@ -680,7 +680,7 @@ Never return user credentials to the client -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/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/oauth-clients#using-pipedream-oauth). +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). ##### Examples @@ -927,7 +927,7 @@ DELETE /{project_id}/apps/{app_id}/accounts `app_id` **string** -The app ID for which you want to delete all connected accounts. `app_id` can be `oauth_app_id` for [OAuth apps](/connect/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) +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) ##### Examples diff --git a/docs-v2/pages/connect/components.mdx b/docs-v2/pages/connect/components.mdx index 1be6ec5f0c3dd..a8f2d0c7a8cb6 100644 --- a/docs-v2/pages/connect/components.mdx +++ b/docs-v2/pages/connect/components.mdx @@ -1,22 +1,33 @@ import { Steps, Tabs } from 'nextra/components' import Callout from '@/components/Callout' -# Embedding components in your application +# Pre-built tools for your app or agent -Pipedream Connect provides APIs to embed [pre-built components](/components) directly in your application -or AI agent, unlocking access to {process.env.REGISTRY_COMPONENTS}+ pre-built API operations. Enable [your end users](/connect/api#external-users) to +Pipedream Connect provides APIs to embed pre-built tools ([triggers and actions](/components)) directly in your application +or AI agent, enabling access to 10,000+ built-in 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? +## What are triggers and actions? -In Pipedream, [components](/components) are self-contained executable units of code. Your end users configure the inputs and the components produce a +In Pipedream, we call triggers and actions [components](/components), which are self-contained executable units of code. Your end users configure the inputs and these components produce a result that's exported as output. These components are developed and maintained by Pipedream and our community and their source code is available in our [public Github repo](https://github.com/PipedreamHQ/pipedream/tree/master/components). +## Implementation + +### Use Pipedream's frontend SDK +- Pipedream provides a frontend React SDK to enable your users to configure and run triggers and actions in your app's UI +- Style the UI components however you want to match the design of your app, and you can also fork the SDK +- Refer to the [SDK](https://github.com/PipedreamHQ/pipedream/blob/master/packages/connect-react/README.md) to get started + -Running components for your end users via Pipedream Connect is in **beta**, and we're looking for feedback. Please [let us know](https://pipedream.com/support) how you're using it, what's not working, and what else you'd like to see. +Check out the [public demo app](https://pdrm.co/connect) to see the API and SDK in action. You can also [run it locally and explore the code](https://github.com/PipedreamHQ/pipedream-connect-examples/tree/master/connect-react-demo). +### Use your own frontend +- See below to get started with the REST API +- Refer to the [full API reference](/connect/api#components) for supported SDK methods as well + ## Getting started diff --git a/docs-v2/pages/connect/environments.mdx b/docs-v2/pages/connect/environments.mdx index 8be50f4040661..6daf5b2b3162d 100644 --- a/docs-v2/pages/connect/environments.mdx +++ b/docs-v2/pages/connect/environments.mdx @@ -6,7 +6,7 @@ import Image from 'next/image' Pipedream Connect projects support two environments: `development` and `production`. Connected accounts and credentials stored in `development` remain separate from `production`. -Pipedream customers on any plan can use all of the Connect features in `development` mode. To use Connect in `production`, click **Contact Sales** [here](https://pipedream.com/pricing?plan=Enterprise) to get in touch with our team. +You can use all of the Connect features in `development` mode **on any plan**. **[Get in touch with our Sales team](https://pipedream.com/pricing?plan=Enterprise)** when you're ready to ship to production. diff --git a/docs-v2/pages/connect/index.mdx b/docs-v2/pages/connect/index.mdx index 62be37755386f..0f8746ffb1e7d 100644 --- a/docs-v2/pages/connect/index.mdx +++ b/docs-v2/pages/connect/index.mdx @@ -5,28 +5,33 @@ import VideoPlayer from "@/components/VideoPlayer"; # Pipedream Connect -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. +**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. -You have full, code-level control over how these integrations work in your app. You handle your product, Pipedream simplifies the integration. +![Connect visualization](https://res.cloudinary.com/pipedreamin/image/upload/v1738731467/pd-connect-viz_cep0uq.png) -Connect lets you: +## Use managed auth -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. [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. +- 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/managed-auth/quickstart#or-use-connect-link) to accept auth in minutes +- Ship new integrations quickly with Pipedream's approved OAuth clients, or use your own -
-Pipedream Connect overview +## Act on behalf of your users + +- Retrieve OAuth access tokens and API keys for your end users with Pipedream's [REST API](/connect/api) +- Add 10,000+ pre-built tools and triggers from {process.env.PUBLIC_APPS}+ APIs to your AI agent or embed them directly in your SaaS app +- Develop and deploy complex multi-step [workflows](/connect/workflows) in our [visual workflow builder](/workflows) +- Use the Connect proxy to make custom API requests + +{/* Pipedream Connect overview */} ## Use cases Pipedream Connect lets you build any API integration into your product in minutes. Our customers build: +- **AI products**: Talk to any AI API or LLM, interacting with your users or running AI-driven asynchronous tasks - **In-app messaging**: Send messages to Slack, Discord, Microsoft Teams, or any app directly from your product. - **CRM syncs**: Sync data between your app and Salesforce, HubSpot, or any CRM -- **AI products**: Talk to any AI API or LLM, interacting with your users or running AI-driven asynchronous tasks - **Spreadsheet integrations**: Sync data between your app and Google Sheets, Airtable, or any spreadsheet [and much more](/connect/use-cases). @@ -35,33 +40,9 @@ Pipedream Connect lets you build any API integration into your product in minute 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 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 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)). - - -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. - - ## Plans and pricing -**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. +**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. ## Security @@ -84,4 +65,4 @@ All credentials and tokens are sent to Pipedream securely over HTTPS, and encryp - **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. - **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. - **Connected Account**: The account your end user connects. [Read more about connected accounts](/connected-accounts). -- **OAuth Client**: Custom OAuth clients you create in Pipedream. [Read more about OAuth clients](/connected-accounts/oauth-clients). +- **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). diff --git a/docs-v2/pages/connect/managed-auth/_meta.tsx b/docs-v2/pages/connect/managed-auth/_meta.tsx new file mode 100644 index 0000000000000..692e9c6c53693 --- /dev/null +++ b/docs-v2/pages/connect/managed-auth/_meta.tsx @@ -0,0 +1,9 @@ +export default { + "quickstart": "Quickstart", + "users": "Users", + "tokens": "Connect Tokens", + "connect-link": "Connect Link", + "oauth-clients": "OAuth Clients", + "webhooks": "Webhooks", + "customization": "Customizing the Auth Flow", +} as const diff --git a/docs-v2/pages/connect/connect-link.mdx b/docs-v2/pages/connect/managed-auth/connect-link.mdx similarity index 86% rename from docs-v2/pages/connect/connect-link.mdx rename to docs-v2/pages/connect/managed-auth/connect-link.mdx index be765308c317a..d10a161989d01 100644 --- a/docs-v2/pages/connect/connect-link.mdx +++ b/docs-v2/pages/connect/managed-auth/connect-link.mdx @@ -8,11 +8,11 @@ If you aren't able to execute JavaScript or open an iFrame in your frontend, or ## How to generate a link -See [the Connect quickstart](/connect/quickstart) for a full tutorial for getting Connect up and running. +See [the Connect quickstart](/connect/managed-auth/quickstart) for a full tutorial for getting Connect up and running. Here's a quick overview of how to generate a Connect Link URL: -1. First, [generate a token](/connect/quickstart/#generate-a-short-lived-token) for your users. +1. First, [generate a token](/connect/managed-auth/quickstart/#generate-a-short-lived-token) for your users. 2. Extract the `connect_link_url` from the token response. 3. Before returning the URL to your user, add an `app` parameter to the end of the query string: diff --git a/docs-v2/pages/connect/customize-your-app.mdx b/docs-v2/pages/connect/managed-auth/customization.mdx similarity index 98% rename from docs-v2/pages/connect/customize-your-app.mdx rename to docs-v2/pages/connect/managed-auth/customization.mdx index 4443ad14f1cb8..b4f842cf3f0c8 100644 --- a/docs-v2/pages/connect/customize-your-app.mdx +++ b/docs-v2/pages/connect/managed-auth/customization.mdx @@ -1,7 +1,7 @@ import ArcadeEmbed from '@/components/ArcadeEmbed' import Callout from '@/components/Callout' -# Customizing Your Application +# Customizing the Auth Flow +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. + \ No newline at end of file diff --git a/docs-v2/pages/connect/webhooks.mdx b/docs-v2/pages/connect/managed-auth/webhooks.mdx similarity index 80% rename from docs-v2/pages/connect/webhooks.mdx rename to docs-v2/pages/connect/managed-auth/webhooks.mdx index be9a4cb2394ae..29f82d93ca026 100644 --- a/docs-v2/pages/connect/webhooks.mdx +++ b/docs-v2/pages/connect/managed-auth/webhooks.mdx @@ -1,6 +1,6 @@ # Connect Webhooks -When you [generate a Connect token](/connect/quickstart/#generate-a-short-lived-token), you can pass a `webhook_uri` parameter. Pipedream will send a POST request to this URL when the user completes the connection flow, or if an error occurs at any point. [See the API docs](/connect/api#create-a-new-token) for details. +When you [generate a Connect token](/connect/managed-auth/quickstart/#generate-a-short-lived-token), you can pass a `webhook_uri` parameter. Pipedream will send a POST request to this URL when the user completes the connection flow, or if an error occurs at any point. [See the API docs](/connect/api#create-a-new-token) for details. ## Webhook events diff --git a/docs-v2/pages/connect/troubleshooting.mdx b/docs-v2/pages/connect/troubleshooting.mdx index 2c3791f450075..c3801caeef4ce 100644 --- a/docs-v2/pages/connect/troubleshooting.mdx +++ b/docs-v2/pages/connect/troubleshooting.mdx @@ -40,7 +40,7 @@ Connect tokens expire, and are only able to be used once. Try generating a new t >App not found. Please check your app id. -Double-check the app slug you're passing [when connecting your user's account](/connect/quickstart#connect-your-users-account). +Double-check the app slug you're passing [when connecting your user's account](/connect/managed-auth/quickstart#connect-your-users-account). ### Connection failed. Please retry or contact support. diff --git a/docs-v2/pages/connect/workflows.mdx b/docs-v2/pages/connect/workflows.mdx index 6cbccecd0a3b4..ac2ff4b7f7c70 100644 --- a/docs-v2/pages/connect/workflows.mdx +++ b/docs-v2/pages/connect/workflows.mdx @@ -71,7 +71,7 @@ When you trigger the workflow, Pipedream will look up the corresponding account To run an end-to-end test as an end user, you need to have users and connected accounts in your project. If you already have a **development** account linked, you can skip this step. -If you don't, the fastest way to do this is [on the **Users** tab](/connect#users) in your Pipedream project: +If you don't, the fastest way to do this is [on the **Users** tab](/connect/managed-auth/users) in your Pipedream project: - You'll see there's a button to **Connect account** - Go through the flow and make sure to create the account in **development** mode - Note the **external user ID** of the account you just connected, you'll need it in the next step @@ -242,7 +242,7 @@ We plan to improve this interface in the future, and potentially allow developer To test a step using the connected account of one of your end users in the builder, you'll need a few things to be configured so that your workflow knows which account to use. **Make sure you have an external user with the relevant connected account(s) saved to your project:** -- Go to the **[Users tab](/connect#users)** in the **Connect** section of your project to confirm +- Go to the **[Users tab](/connect/managed-auth/users)** in the **Connect** section of your project to confirm - If not, either connect one from your application or [directly in the UI](#connect-a-test-account) **Pass the environment and external user ID:** @@ -393,11 +393,11 @@ Pipedream Connect Error: Required account for hubspot not found for external use #### No matching external user ID - There was an external user ID passed, but it didn't match any users in the project. -- Double-check that the external user ID that you passed when invoking the workflow matches one either [in the UI](/connect#users) or [via the API](/connect/api#accounts). +- Double-check that the external user ID that you passed when invoking the workflow matches one either [in the UI](/connect/managed-auth/users) or [via the API](/connect/api#accounts). #### Required account not found for external user ID - The external user ID was passed when invoking the workflow, but the user doesn't have a connected account for one or more of the apps that are configured to use it in this workflow execution. -- You can check which connected accounts are available for that user [in the UI](/connect#users) or [via the API](/connect/api#accounts). +- You can check which connected accounts are available for that user [in the UI](/connect/managed-auth/users) or [via the API](/connect/api#accounts). #### Running workflows for your users in production requires a higher tier plan - Anyone is able to run workflows for your end users in `development`. The Business plan is required to run on behalf of `production` users. diff --git a/docs-v2/pages/rest-api/auth.mdx b/docs-v2/pages/rest-api/auth.mdx index 531a8fee30893..b40caca6d52fe 100644 --- a/docs-v2/pages/rest-api/auth.mdx +++ b/docs-v2/pages/rest-api/auth.mdx @@ -40,17 +40,15 @@ const pd = createBackendClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET", }, + projectId: "YOUR_PROJECT_ID", // This is typically required for most Connect API endpoints }); // Use the SDK's helper methods to make requests const accounts = await pd.getAccounts({ include_credentials: 1 }); // Or make any Pipedream API request with the fresh token -const accounts = await pd.makeRequest("/accounts", { +const accounts = await pd.makeAuthorizedRequest("/accounts", { method: "GET" - headers: { - "Authorization": await this.oauthAuthorizationHeader(), // Automatically uses a fresh token - }, params: { include_credentials: 1, } diff --git a/docs-v2/pages/rest-api/index.mdx b/docs-v2/pages/rest-api/index.mdx index efdf6723b0bf4..dbfe68cc1660c 100644 --- a/docs-v2/pages/rest-api/index.mdx +++ b/docs-v2/pages/rest-api/index.mdx @@ -189,7 +189,7 @@ You can find the app's ID in the response from the [List apps](#list-apps) endpo `oauth_app_id` **string** (_optional_) -The ID of the custom [OAuth app](/connect/quickstart#create-a-pipedream-oauth-client) you'd like to retrieve accounts for. +The ID of the custom [OAuth app](/connect/managed-auth/quickstart#create-a-pipedream-oauth-client) you'd like to retrieve accounts for. --- diff --git a/docs-v2/vercel.json b/docs-v2/vercel.json index 8a7d4e042f637..8d512d50050d3 100644 --- a/docs-v2/vercel.json +++ b/docs-v2/vercel.json @@ -289,6 +289,34 @@ { "source": "/docs/connect/quickstart#connect-a-users-account", "destination": "/docs/connect/quickstart#connect-your-users-account" + }, + { + "source": "/docs/connect/connect-link", + "destination": "/docs/connect/managed-auth/connect-link" + }, + { + "source": "/docs/connect/customize-your-app", + "destination": "/docs/connect/managed-auth/customization" + }, + { + "source": "/docs/connect/oauth-clients", + "destination": "/docs/connect/managed-auth/oauth-clients" + }, + { + "source": "/docs/connect/quickstart", + "destination": "/docs/connect/managed-auth/quickstart" + }, + { + "source": "/docs/connect/tokens", + "destination": "/docs/connect/managed-auth/tokens" + }, + { + "source": "/docs/connect/webhooks", + "destination": "/docs/connect/managed-auth/webhooks" + }, + { + "source": "/connect/oauth-clients#using-your-own-oauth-client", + "destination": "/connect/managed-auth/oauth-clients#using-a-custom-oauth-client" } ] }