Sign in

Create OAuth client

Register a custom OAuth client for an app

post/v1/connect/{project_id}/oauth_apps

Request body

appstring required

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

client_idstring required

The OAuth client ID registered with the upstream provider

client_secretstring required

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

namestring

Display name of the OAuth client

descriptionstring

Description of the OAuth client

scopesstring[]

OAuth scopes to request when users connect through this client

additional_scopesstring[]

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

Response

OAuth client created

idstring nullable required

Hash ID for the OAuth client

name_slugstring required

The name slug of the target app (see https://pipedream.com/docs/connect/quickstart#find-your-apps-name-slug)

namestring required

The human-readable name of the app

auth_type'keys' | 'oauth' | 'none' nullable

The authentication type used by the app

descriptionstring nullable

A short description of the app

img_srcstring required

The URL to the app's logo

custom_fields_jsonstring nullable required

A JSON string representing the custom fields for the app

categoriesstring[] required

Categories associated with the app

featured_weightnumber required

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

client_idstring required

The OAuth client ID registered with the upstream provider

scopesstring[]

OAuth scopes requested when users connect through this client

additional_scopesstring[] nullable

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

redirect_uristring

The redirect URI to register with the upstream OAuth provider

owner_idstring required

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

created_atstring date-time
updated_atstring date-time

Changes

Changed in 1 of the 2 revisions of this API.1