Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.

Path Parameters

project_id
string
required

The project ID, which starts with proj_.

Pattern: ^proj_[a-zA-Z0-9]+$

Body

application/json
app
string
required

The app's ID or name slug. The app must have custom OAuth clients enabled.

client_id
string
required

The OAuth client ID registered with the upstream provider

client_secret
string
required

The OAuth client secret. Write-only; never returned in responses.

name
string

Display name of the OAuth client

description
string

Description of the OAuth client

scopes
string[]

OAuth scopes to request when users connect through this client

additional_scopes
string[]

Extra OAuth scopes users may grant on top of the base scopes

Response

OAuth client created

A custom OAuth client (bring your own app), presented as its app's metadata merged with the client's own fields. name and description fall back to the app's when the client doesn't set them. The client secret is write-only and never returned.

id
string
required

Hash ID for the OAuth client

Pattern: ^oa_[0-9A-Za-z]+$
name_slug
string
required
name
string
required

The human-readable name of the app

img_src
string
required

The URL to the app's logo

custom_fields_json
string | null
required

A JSON string representing the custom fields for the app

categories
string[]
required

Categories associated with the app

A rough directional ordering of app popularity, subject to changes by Pipedream

scope_profiles
object[]
required

Named subsets of the app's OAuth scopes that may be requested when users connect their accounts (via the oauth_scope_profile parameter). Empty for apps that don't define any.

client_id
string
required

The OAuth client ID registered with the upstream provider

owner_id
string
required

Hash ID of the owner: the workspace (o_...) or the project (proj_...)

auth_type
enum<string> | null

The authentication type used by the app

Available options:
keys,
oauth,
none
description
string | null

A short description of the app

scopes
string[]

OAuth scopes requested when users connect through this client

additional_scopes
string[] | null

Extra OAuth scopes users may grant on top of the base scopes

redirect_uri
string

The redirect URI to register with the upstream OAuth provider

created_at
string<date-time>
updated_at
string<date-time>