OAuth Clients

When connecting an account for any OAuth app via Pipedream Connect, we’ll default to using Pipedream’s official OAuth client, which enables you to quickly get up and running. Read more about OAuth clients in Pipedream here.

Using Pipedream OAuth

There are two types of apps in Pipedream:

Key-based: These apps require static credentials, like API keys. Pipedream stores these credentials securely and exposes them via API.
OAuth: These apps require OAuth authorization. Pipedream manages the OAuth flow for these apps, ensuring you always have a fresh access token for requests.

For any OAuth app that supports it, you can always use your own client. Your ability to use Pipedream’s OAuth clients in production depends on the use case. See below for details.

Operation	Details	Pipedream	Custom
Retrieve user credentials	Fetch the credentials for your end user from Pipedream’s API to use in your app	❌	✅
Invoke workflows	Trigger any Pipedream workflow and use the connected account of your end users	❌	✅
Embed prebuilt tools	Run any action and deploy any trigger directly from your AI agent or app	✅	✅
Proxy API requests	Write custom code to interface with any integrated API while avoiding dealing with user auth	✅	✅

Using a custom OAuth client

Follow the steps here to create an OAuth client in Pipedream, or create one with the API.
When connecting an account either via the frontend SDK, make sure to include the oauthAppId in pd.connectAccount().
If using Connect Link, make sure to include the oauthAppId in the URL.

Finding your OAuth app ID

Create your OAuth client in Pipedream then click the arrow to the left of the client name to expand the details.

Managing OAuth clients with the API

You can also create and manage custom OAuth clients through the Connect API, instead of the Pipedream UI. Clients are owned by either a workspace or a project, and listing them for a project returns the project’s own clients and those of its parent workspace.

The clientId and clientSecret you pass when creating a client are the credentials the third-party app issued to you. They are not your Pipedream OAuth credentials, which you pass to the client constructor.

import { PipedreamClient } from "@pipedream/sdk";

const client = new PipedreamClient({
  projectEnvironment: "development",
  projectId: "{your_pipedream_project_id}",
  clientId: "{your_pipedream_oauth_client_id}",
  clientSecret: "{your_pipedream_oauth_client_secret}"
});

const oauthApp = await client.oauthApps.create({
  app: "servicenow",
  name: "Acme ServiceNow",
  clientId: "{your_servicenow_client_id}",
  clientSecret: "{your_servicenow_client_secret}"
});

console.log(oauthApp.id); // oa_a1b2c3
console.log(oauthApp.redirectUri); // Register this URI with the third-party app

from pipedream import Pipedream

pd = Pipedream(
    project_environment="development",
    project_id="{your_pipedream_project_id}",
    client_id="{your_pipedream_oauth_client_id}",
    client_secret="{your_pipedream_oauth_client_secret}"
)

oauth_app = pd.oauth_apps.create(
    app="servicenow",
    name="Acme ServiceNow",
    client_id="{your_servicenow_client_id}",
    client_secret="{your_servicenow_client_secret}"
)

print(oauth_app.id)  # oa_a1b2c3
print(oauth_app.redirect_uri)  # Register this URI with the third-party app

curl -X POST https://api.pipedream.com/v1/connect/{project_id}/oauth_apps \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "app": "servicenow",
    "name": "Acme ServiceNow",
    "client_id": "{your_servicenow_client_id}",
    "client_secret": "{your_servicenow_client_secret}"
  }'

Each client returns a unique redirect_uri. Register it with the third-party app so it redirects users back to Pipedream. The app must have custom OAuth clients enabled.

The client secret is write-only. Pipedream never returns it in a response. On update, a blank value keeps the existing secret.

See the OAuth Clients API reference for all endpoints.

Pre-configuring other app fields

Some apps need more than OAuth credentials to connect, such as a hostname or instance name. Use an app override to pre-define those values, and to attach a custom OAuth client to them, so your end users don’t have to supply them.

Getting Started

Connect

Workflows

Platform

Additional Resources

Using Pipedream OAuth

Using a custom OAuth client

Finding your OAuth app ID

Managing OAuth clients with the API

Pre-configuring other app fields

​Using Pipedream OAuth

​Using a custom OAuth client

​Finding your OAuth app ID

​Managing OAuth clients with the API

​Pre-configuring other app fields

Using Pipedream OAuth

Using a custom OAuth client

Finding your OAuth app ID

Managing OAuth clients with the API

Pre-configuring other app fields