Connect API & SDK reference

import {
  createBackendClient,
  type ConnectAPIResponse,
  type ConnectTokenCreateOpts,
  type ConnectTokenResponse,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
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)
});

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
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)
});

# 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": "{oauth_client_id}",
    "client_secret": "{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/{project_id}/tokens \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: development" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{your_external_user_id}",
    "allowed_origins": [
      "http://localhost:3000",
      "https://example.com"
    ],
  }'

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
const accounts = await pd.getAccounts({
  app: "github", // optional, filter by app
  external_user_id: "user-abc-123", // optional, filter by external user ID
  include_credentials: true, // optional, set to true to include credentials
});
 
// Parse and return the data you need. These may contain credentials,
// which you should never return to the client

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
const accounts = await pd.getAccounts({
  app: "github", // optional, filter by app
  external_user_id: "user-abc-123", // optional, filter by external user ID
  include_credentials: true, // optional, set to true to include credentials
});
 
// Parse and return the data you need. These may contain credentials,
// which you should never return to the client

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
 
curl -X GET \
  -G \
  "https://api.pipedream.com/v1/connect/{project_id}/accounts" \
  -H "Authorization: Bearer {access_token}" \
  -d "app=github" \ # optional, filter by app
  -d "external_user_id=user-abc-123" \ # optional, filter by external user ID
  -d "include_credentials=true" # optional, include credentials
 
 
# Parse and return the data you need. These may contain credentials,
# which you should never return to the client

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
const account = await pd.getAccountById(accountId, {
  app: "github", // optional, filter by app
  external_user_id: "user-abc-123", // optional, filter by external user ID
  include_credentials: true, // optional, set to true to include credentials
});
 
// Parse and return the data you need. These may contain credentials,
// which you should never return to the client

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
const accountId = "{account_id}"; // Replace with your account ID
 
const account = await pd.getAccountById(accountId, {
  app: "github", // optional, filter by app
  external_user_id: "user-abc-123", // optional, filter by external user ID
  include_credentials: true, // optional, set to true to include credentials
});
 
// Parse and return the data you need. These may contain credentials,
// which you should never return to the client

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
 
curl -X GET \
  -G \
  "https://api.pipedream.com/v1/connect/{project_id}/accounts/{account_id}" \
  -H "Authorization: Bearer {access_token}" \
  -d "app=github" \ # optional, filter by app
  -d "external_user_id=user-abc-123" \ # optional, filter by external user ID
  -d "include_credentials=true" # optional, include credentials
 
# Parse and return the data you need. These may contain credentials,
# which you should never return to the client

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
await pd.deleteAccount(accountId);
 
// You can return a message or handle any post-deletion logic here.

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
await pd.deleteAccount(accountId);
 
// You can return a message or handle any post-deletion logic here.

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
 
curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/accounts/{account_id}" \
  -H "Authorization: Bearer {access_token}"

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
await pd.deleteAccountsByApp(appId);
 
// You can return a message or handle any post-deletion logic here.

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
await pd.deleteAccount(accountId);
 
// You can return a message or handle any post-deletion logic here.

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
 
curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/accounts/{account_id}" \
  -H "Authorization: Bearer {access_token}"

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
await pd.deleteExternalUser(externalId);
 
console.log("All accounts associated with the external ID have been deleted.");

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
const externalId = "{external_user_id}"; // Replace with your external user ID
 
await pd.deleteExternalUser(externalId);
 
console.log("All accounts associated with the external ID have been deleted.");

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
 
curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/users/{external_user_id}" \
  -H "Authorization: Bearer {access_token}"

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Retrieve components containing the word "issue" in their name, belonging to
// the Gitlab app
const { data: components } = await pd.getComponents({
  app: "gitlab",
  q: "issue",
});
 
// Parse and return the data you need

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Retrieve components containing the word "issue" in their name, belonging to
// the Gitlab app
const { data: components } = await pd.getComponents({
  app: "gitlab",
  q: "issue",
});
 
// Parse and return the data you need

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
# This request will fetch the first 3 components for the Gitlab app that contain
# the word "issue" in their name
curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components?app=gitlab&limit=3&q=issue" \
  -H "Authorization: Bearer {access_token}"

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Retrieve the "New Issue (Instant)" component for the Gitlab app
const { data: component } = await pd.getComponent({
  key: "gitlab-new-issue",
});
 
// Parse and return the data you need

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Retrieve the "New Issue (Instant)" component for the Gitlab app
const { data: component } = await pd.getComponent({
  key: "gitlab-new-issue",
});
 
// Parse and return the data you need

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
# This request will fetch the "New Issue (Instant)" component for the Gitlab app.
curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components/gitlab-new-issue" \
  -H "Authorization: Bearer {access_token}"

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Retrieve the configuration options for the "projectId" prop of the "List
// Commits" component for the Gitlab app.
const { options } = await pd.configureComponent({
  componentId: {
    key: "gitlab-list-commits",
  },
  configuredProps: {
    gitlab: {
      authProvisionId: "apn_kVh9AoD",
    },
  },
  externalUserId: "jverce",
  propName: "projectId",
});
 
// Parse and return the data you need

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Retrieve the configuration options for the "projectId" prop of the "List
// Commits" component for the Gitlab app.
const { options } = await pd.configureComponent({
  componentId: {
    key: "gitlab-list-commits",
  },
  configuredProps: {
    gitlab: {
      authProvisionId: "apn_kVh9AoD",
    },
  },
  externalUserId: "jverce",
  propName: "projectId",
});
 
// Parse and return the data you need

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
# This request will fetch the configuration options for the "projectId" prop of
# the "List Commits" component for the Gitlab app.
 
echo '{
  "external_user_id": "jverce",
  "id": "gitlab-list-commits",
  "prop_name": "projectId",
  "configured_props": {
    "gitlab": {
      "authProvisionId": "apn_kVh9AoD"
    }
  }
}' > data.json
 
curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/components/configure" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d @data.json

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// 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({
  componentId: {
    key: "google_sheets-add-single-row",
  },
  configuredProps: {
    googleSheets: {
      authProvisionId: "apn_V1hMoE7",
    },
    sheetId: "1BfWjFF2dTW_YDiLISj5N9nKCUErShgugPS434liyytg",
  },
  externalUserId: "jay",
});
 
const {
  configurableProps,  // The new set of props
  id: dynamicPropsId, // The ID of the last prop reconfiguration
} = dynamicProps;
 
// Parse and return the data you need

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// 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({
  componentId: {
    key: "google_sheets-add-single-row",
  },
  configuredProps: {
    googleSheets: {
      authProvisionId: "apn_V1hMoE7",
    },
    sheetId: "1BfWjFF2dTW_YDiLISj5N9nKCUErShgugPS434liyytg",
  },
  externalUserId: "jay",
});
 
const {
  configurableProps,  // The new set of props
  id: dynamicPropsId, // The ID of the last prop reconfiguration
} = dynamicProps;
 
// Parse and return the data you need

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
# This request will fetch the new set of props for the "Add Single Row" component
# for the Google Sheets app. Note that the `sheetId` prop is a dynamic prop.
 
echo '{
  "external_user_id": "jay",
  "id": "google_sheets-add-single-row",
  "configured_props": {
    "googleSheets": {
      "authProvisionId": "apn_V1hMoE7"
    },
    "sheetId": "1BfWjFF2dTW_YDiLISj5N9nKCUErShgugPS434liyytg"
  }
}' > data.json
 
curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/components/props" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d @data.json

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Run the "List Commits" action for the Gitlab app
const {
  exports,  // The named exports produced by the action
  os,       // The observations produced by the action
  ret,      // The value returned by the action
} = await pd.runAction({
  actionId: {
    key: "gitlab-list-commits",
  },
  configuredProps: {
    gitlab: {
      authProvisionId: "apn_kVh9AoD",
    },
    projectId: 45672541,
    refName: "main"
  },
  externalUserId: "jverce",
});
 
// Parse and return the data you need

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Run the "List Commits" action for the Gitlab app
const {
  exports,  // The named exports produced by the action
  os,       // The observations produced by the action
  ret,      // The value returned by the action
} = await pd.runAction({
  actionId: {
    key: "gitlab-list-commits",
  },
  configuredProps: {
    gitlab: {
      authProvisionId: "apn_kVh9AoD",
    },
    projectId: 45672541,
    refName: "main"
  },
  externalUserId: "jverce",
});
 
// Parse and return the data you need

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
# This request will run the "List Commits" action for the Gitlab app.
 
echo '{
  "external_user_id": "jverce",
  "id": "gitlab-list-commits",
  "configured_props": {
    "gitlab": {
      "authProvisionId": "apn_kVh9AoD"
    },
    "projectId": 45672541,
    "refName": "main"
  }
}' > data.json
 
curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/actions/run" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d @data.json

import {
  createBackendClient,
} from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Deploy the "New Issue (Instant)" trigger for the Gitlab app
const { data: deployedTrigger } = await pd.deployTrigger({
  triggerId: {
    key: "gitlab-new-issue",
  },
  configuredProps: {
    gitlab: {
      authProvisionId: "apn_kVh9AoD",
    },
    projectId: 45672541,
  },
  externalUserId: "jverce",
  webhookUrl: "https://events.example.com/gitlab-new-issue",
});
 
const {
  id: triggerId,      // The unique ID of the deployed trigger
  name: triggerName,  // The name of the deployed trigger
  owner_id: userId,   // The unique ID in Pipedream of your user
} = deployedTrigger;
 
// Parse and return the data you need

import { createBackendClient } from "@pipedream/sdk/server";
 
const pd = createBackendClient({
  environment: "development", // change to production if running for a test production account, or in production
  credentials: {
    clientId: "{oauth_client_id}",
    clientSecret: "{oauth_client_secret}",
  },
  projectId: "{your_project_id}"
});
 
// Deploy the "New Issue (Instant)" trigger for the Gitlab app
const { data: deployedTrigger } = await pd.deployTrigger({
  triggerId: {
    key: "gitlab-new-issue",
  },
  configuredProps: {
    gitlab: {
      authProvisionId: "apn_kVh9AoD",
    },
    projectId: 45672541,
  },
  externalUserId: "jverce",
  webhookUrl: "https://events.example.com/gitlab-new-issue",
});
 
const {
  id: triggerId,      // The unique ID of the deployed trigger
  name: triggerName,  // The name of the deployed trigger
  owner_id: userId,   // The unique ID in Pipedream of your user
} = deployedTrigger;
 
// Parse and return the data you need

# 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": "{oauth_client_id}",
    "client_secret": "{oauth_client_secret}"
  }'
 
# The response will include an access_token. Use it in the Authorization header below.
# This request will deploy the "New Issue (Instant)" trigger for the Gitlab app.
 
echo '{
  "external_user_id": "jverce",
  "id": "gitlab-new-issue",
  "configured_props": {
    "gitlab": {
      "authProvisionId": "apn_kVh9AoD"
    },
    "projectId": 45672541,
  },
  "webhook_url": "https://events.example.com/gitlab-new-issue"
}' > data.json
 
curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/triggers/deploy" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d @data.json