Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
16 changes: 8 additions & 8 deletions docs-v2/pages/connect/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1450,7 +1450,7 @@ const pd: BackendClient = createBackendClient(clientOpts);
// Retrieve the configuration options for the "projectId" prop of the "List
// Commits" component for the Gitlab app.
const requestOpts: ConfigureComponentOpts = {
id: "gitlab-list-commits",
componentId: "gitlab-list-commits",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -1489,7 +1489,7 @@ const pd = createBackendClient({
// Retrieve the configuration options for the "projectId" prop of the "List
// Commits" component for the Gitlab app.
const { options } = await pd.configureComponent({
id: "gitlab-list-commits",
componentId: "gitlab-list-commits",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -1662,7 +1662,7 @@ const pd: BackendClient = createBackendClient(clientOpts);
// Retrieve the configuration options for the "Add Single Row" component for
// the Google Sheets app. Note that the `sheetId` prop is a dynamic prop.
const requestOpts: ReloadComponentPropsOpts = {
id: "google_sheets-add-single-row",
componentId: "google_sheets-add-single-row",
configuredProps: {
googleSheets: {
authProvisionId: "apn_V1hMoE7",
Expand Down Expand Up @@ -1699,7 +1699,7 @@ const pd = createBackendClient({
// Retrieve the configuration options for the "Add Single Row" component for
// the Google Sheets app. Note that the `sheetId` prop is a dynamic prop.
const { dynamicProps } = await pd.reloadComponentProps({
id: "google_sheets-add-single-row",
componentId: "google_sheets-add-single-row",
configuredProps: {
googleSheets: {
authProvisionId: "apn_V1hMoE7",
Expand Down Expand Up @@ -1873,7 +1873,7 @@ const pd: BackendClient = createBackendClient(clientOpts);

// Run the "List Commits" action for the Gitlab app
const requestOpts: RunActionOpts = {
id: "gitlab-list-commits",
actionId: "gitlab-list-commits",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -1916,7 +1916,7 @@ const {
os, // The observations produced by the action
ret, // The value returned by the action
} = await pd.runAction({
id: "gitlab-list-commits",
actionId: "gitlab-list-commits",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -2078,7 +2078,7 @@ const pd: BackendClient = createBackendClient(clientOpts);

// Deploy the "New Issue (Instant)" trigger for the Gitlab app
const requestOpts: DeployTriggerOpts = {
id: "gitlab-new-issue",
triggerId: "gitlab-new-issue",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -2117,7 +2117,7 @@ const pd = createBackendClient({

// Deploy the "New Issue (Instant)" trigger for the Gitlab app
const { data: deployedTrigger } = await pd.deployTrigger({
id: "gitlab-new-issue",
triggerId: "gitlab-new-issue",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down
16 changes: 8 additions & 8 deletions docs-v2/pages/connect/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ as an example, to illustrate a call that retrieves the options for the
```javascript
const { options } = await pd.configureComponent({
externalUserId: "abc-123",
id: "gitlab-list-commits",
componentId: "gitlab-list-commits",
propName: "projectId",
configuredProps: {
gitlab: {
Expand Down Expand Up @@ -605,7 +605,7 @@ to the following endpoint:
```javascript
const resp = await pd.runAction({
externalUserId: "abc-123",
id: "gitlab-list-commits",
actionId: "gitlab-list-commits",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -713,7 +713,7 @@ Deploy a source for your users:
```javascript
const { data: deployedTrigger } = await pd.deployTrigger({
externalUserId: "abc-123",
id: "gitlab-new-issue",
triggerId: "gitlab-new-issue",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -852,7 +852,7 @@ Generate a unique HTTP webhook URL for your end users to configure in any other
```javascript
const { data: deployedTrigger } = await pd.deployTrigger({
externalUserId: "abc-123",
id: "http-new-requests",
triggerId: "http-new-requests",
webhookUrl: "https://events.example.com/http-new-requests"
});

Expand Down Expand Up @@ -917,7 +917,7 @@ When defining schedules, you can pass one of the following:
```javascript
const { data: deployedTrigger } = await pd.deployTrigger({
externalUserId: "abc-123",
id: "schedule-custom-interval",
triggerId: "schedule-custom-interval",
configuredProps: {
"cron": {
"intervalSeconds": 900
Expand Down Expand Up @@ -977,7 +977,7 @@ Generate a unique email address for your customers to emit events to
```javascript
const { data: deployedTrigger } = await pd.deployTrigger({
externalUserId: "abc-123",
id: "email-new-email",
triggerId: "email-new-email",
webhookUrl: "https://events.example.com/email-new-email"
});

Expand Down Expand Up @@ -1123,7 +1123,7 @@ You can call `configureComponent` on the `sql` prop to retrieve database schema
const resp = await pd.configureComponent({
externalUserId: externalUserId,
propName: "sql",
id: "postgresql-execute-custom-query",
componentId: "postgresql-execute-custom-query",
configuredProps: {
postgresql: {
authProvisionId: accountId
Expand Down Expand Up @@ -1235,7 +1235,7 @@ const { dynamicProps } = await pd.reloadProps({ … });
// Then use the dynamicProps.id when running the action
const resp = await pd.runAction({
externalUserId: "abc-123",
id: "google_sheets-add-single-row",
actionId: "google_sheets-add-single-row",
dynamicPropsId: dynamicProps.id, // Must include this
configuredProps: {
googleSheets: {
Expand Down
10 changes: 5 additions & 5 deletions docs-v2/pages/connect/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ import VideoPlayer from "@/components/VideoPlayer";

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

## Use managed auth
## Managed auth

- 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


## Act on behalf of your users
## Make requests on behalf of your users

- Retrieve OAuth access tokens and API keys for your end users with Pipedream's [REST API](/connect/api/)
- [Add 10k pre-built tools and triggers](/connect/components) from {process.env.PUBLIC_APPS}+ APIs to your AI agent or embed them in your SaaS app
- Develop and deploy complex multi-step [workflows](/connect/workflows/) in our best-in-class [visual builder](/workflows/building-workflows/)
- Use [Pipedream's MCP server](/connect/mcp/developers) to provide your AI agent 10,000+ tools from {process.env.PUBLIC_APPS}+ APIs
- Add our [entire registry](https://github.com/PipedreamHQ/pipedream/tree/master/components) of [pre-built tools and triggers](/connect/components) from {process.env.PUBLIC_APPS}+ APIs to your SaaS app or workflow builder
- Send custom API requests while still avoiding dealing with customer credentials with the [Connect proxy](/connect/api-proxy/)
- Develop and deploy complex multi-step [workflows](/connect/workflows/) in our best-in-class [visual builder](/workflows/building-workflows/)

{/* <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} /> */}

Expand Down
2 changes: 1 addition & 1 deletion docs-v2/pages/connect/managed-auth/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Check out the [full API docs](/connect/api/#create-token) for all parameters you
Now that your users have connected an account, you can use their auth in one of a few ways:

1. [Expose 10k+ tools](/connect/components/) to your AI app or agent and call them on behalf of your customers
2. [Send custom requests](/connect/proxy/) to any one of the 2500+ APIs using the Connect API proxy
2. [Send custom requests](/connect/api-proxy/) to any one of the 2500+ APIs using the Connect API proxy
3. [Use Pipedream's visual workflow builder](/connect/workflows/) to define complex logic to run on behalf of your users
4. [Embed Pipedream components directly in your app](/connect/components/) to run actions and triggers on their behalf

Expand Down
3 changes: 1 addition & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading