Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: '2026-05-22'
title: Pipedream Actions API
description: 'The Pipedream API is the unified REST surface for Pipedream''s workflow automation, Connect (embedded integrations), MCP, and proxy services. It exposes account, user, component, action, trigger, deployed-trigger, webhook, project, proxy, file_stash, token, usage, and OAuth endpoints. Authentication is via OAuth 2.0 client credentials or a short-lived Connect token. Source: https://pipedream.com/docs/pipedream_openapi_swagger.json'
contact:
name: Pipedream
url: https://pipedream.com/docs/
license:
name: Proprietary
url: https://pipedream.com/terms
servers:
- url: https://api.pipedream.com
tags:
- name: Actions
paths:
/v1/connect/{project_id}/actions:
parameters:
- name: project_id
in: path
required: true
description: The project ID, which starts with `proj_`.
schema:
type: string
pattern: ^proj_[a-zA-Z0-9]+$
x-fern-sdk-variable: project_id
get:
summary: List Actions
description: Retrieve available actions with optional search and app filtering
operationId: listActions
x-fern-sdk-group-name: actions
x-fern-sdk-method-name: list
x-fern-pagination:
cursor: $request.after
next_cursor: $response.page_info.end_cursor
results: $response.data
parameters:
- name: after
in: query
required: false
description: The cursor to start from for pagination
schema:
type: string
- name: before
in: query
required: false
description: The cursor to end before for pagination
schema:
type: string
- name: limit
in: query
required: false
description: The maximum number of results to return
schema:
type: integer
- name: x-pd-environment
in: header
required: true
description: The environment in which the server client is running
schema:
$ref: '#/components/schemas/ProjectEnvironment'
- name: q
in: query
description: A search query to filter the actions
schema:
type: string
- name: app
in: query
description: The ID or name slug of the app to filter the actions
schema:
type: string
- name: registry
in: query
schema:
type: string
enum:
- public
- private
- all
description: The registry to retrieve actions from. Defaults to 'all' ('public', 'private', or 'all')
security:
- ConnectToken: []
- OAuth2: []
responses:
'200':
description: returns public + private without permission
content:
application/json:
schema:
$ref: '#/components/schemas/GetComponentsResponse'
'400':
description: rejects invalid registry value
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: too many requests
headers:
Retry-After:
description: Number of seconds until the rate limit resets
schema:
type: integer
X-RateLimit-Limit:
schema:
type: integer
description: The rate limit threshold
X-RateLimit-Remaining:
schema:
type: integer
description: Number of requests remaining (always 0 when throttled)
X-RateLimit-Reset:
schema:
type: integer
description: Unix timestamp when the rate limit resets
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Throttled
x-codeSamples:
- lang: java
label: Java SDK
source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.resources.actions.requests.ActionsListRequest;\nimport com.pipedream.api.resources.actions.types.ActionsListRequestRegistry;\n\npublic class Example {\n public static void main(String[] args) {\n BaseClient client = BaseClient\n .builder()\n .clientId(\"<clientId>\")\n .clientSecret(\"<clientSecret>\")\n .projectId(\"YOUR_PROJECT_ID\")\n .build();\n\n client.actions().list(\n ActionsListRequest\n .builder()\n .after(\"after\")\n .before(\"before\")\n .limit(1)\n .q(\"q\")\n .app(\"app\")\n .registry(ActionsListRequestRegistry.PUBLIC)\n .build()\n );\n }\n}\n"
- lang: typescript
label: TypeScript SDK
source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n clientId: \"YOUR_CLIENT_ID\",\n clientSecret: \"YOUR_CLIENT_SECRET\",\n projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n projectId: \"YOUR_PROJECT_ID\"\n});\nconst response = await client.actions.list({\n after: \"after\",\n before: \"before\",\n limit: 1,\n q: \"q\",\n app: \"app\",\n registry: \"public\"\n});\nfor await (const item of response) {\n console.log(item);\n}\n\n// Or you can manually iterate page-by-page\nlet page = await client.actions.list({\n after: \"after\",\n before: \"before\",\n limit: 1,\n q: \"q\",\n app: \"app\",\n registry: \"public\"\n});\nwhile (page.hasNextPage()) {\n page = page.getNextPage();\n}\n"
- lang: python
label: Python SDK
source: "from pipedream import Pipedream\n\nclient = Pipedream(\n project_id=\"YOUR_PROJECT_ID\",\n project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\",\n)\nresponse = client.actions.list(\n after=\"after\",\n before=\"before\",\n limit=1,\n q=\"q\",\n app=\"app\",\n registry=\"public\",\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n"
tags:
- Actions
/v1/connect/{project_id}/actions/{component_id}:
parameters:
- name: project_id
in: path
required: true
description: The project ID, which starts with `proj_`.
schema:
type: string
pattern: ^proj_[a-zA-Z0-9]+$
x-fern-sdk-variable: project_id
get:
summary: Retrieve Action
description: Get detailed configuration for a specific action by its key
operationId: retrieveAction
x-fern-sdk-group-name: actions
x-fern-sdk-method-name: retrieve
security:
- ConnectToken: []
- OAuth2: []
parameters:
- name: x-pd-environment
in: header
required: true
description: The environment in which the server client is running
schema:
$ref: '#/components/schemas/ProjectEnvironment'
- name: component_id
in: path
required: true
description: The key that uniquely identifies the component (e.g., 'slack-send-message')
schema:
type: string
- name: version
in: query
required: false
description: Optional semantic version of the component to retrieve (for example '1.0.0')
example: 1.2.3
schema:
type: string
x-fern-sdk-return-value: data
responses:
'200':
description: action retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/GetComponentResponse'
'429':
description: too many requests
headers:
Retry-After:
description: Number of seconds until the rate limit resets
schema:
type: integer
X-RateLimit-Limit:
schema:
type: integer
description: The rate limit threshold
X-RateLimit-Remaining:
schema:
type: integer
description: Number of requests remaining (always 0 when throttled)
X-RateLimit-Reset:
schema:
type: integer
description: Unix timestamp when the rate limit resets
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Throttled
x-codeSamples:
- lang: java
label: Java SDK
source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.resources.actions.requests.ActionsRetrieveRequest;\n\npublic class Example {\n public static void main(String[] args) {\n BaseClient client = BaseClient\n .builder()\n .clientId(\"<clientId>\")\n .clientSecret(\"<clientSecret>\")\n .projectId(\"YOUR_PROJECT_ID\")\n .build();\n\n client.actions().retrieve(\n \"component_id\",\n ActionsRetrieveRequest\n .builder()\n .build()\n );\n }\n}\n"
- lang: typescript
label: TypeScript SDK
source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n clientId: \"YOUR_CLIENT_ID\",\n clientSecret: \"YOUR_CLIENT_SECRET\",\n projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.actions.retrieve(\"component_id\", {\n version: \"1.2.3\"\n});\n"
- lang: python
label: Python SDK
source: "from pipedream import Pipedream\n\nclient = Pipedream(\n project_id=\"YOUR_PROJECT_ID\",\n project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.actions.retrieve(\n component_id=\"component_id\",\n version=\"1.2.3\",\n)\n"
tags:
- Actions
/v1/connect/{project_id}/actions/configure:
parameters:
- name: project_id
in: path
required: true
description: The project ID, which starts with `proj_`.
schema:
type: string
pattern: ^proj_[a-zA-Z0-9]+$
x-fern-sdk-variable: project_id
post:
summary: Configure Action Prop
description: Retrieve remote options for a given prop for a action
operationId: configureActionProp
x-fern-sdk-group-name: actions
x-fern-sdk-method-name: configureProp
security:
- ConnectToken: []
- OAuth2: []
parameters:
- name: x-pd-environment
in: header
required: true
description: The environment in which the server client is running
schema:
$ref: '#/components/schemas/ProjectEnvironment'
responses:
'200':
description: action configuration started
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurePropResponse'
'202':
description: Async operation started
'429':
description: too many requests
headers:
Retry-After:
description: Number of seconds until the rate limit resets
schema:
type: integer
X-RateLimit-Limit:
schema:
type: integer
description: The rate limit threshold
X-RateLimit-Remaining:
schema:
type: integer
description: Number of requests remaining (always 0 when throttled)
X-RateLimit-Reset:
schema:
type: integer
description: Unix timestamp when the rate limit resets
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Throttled
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurePropOpts'
x-codeSamples:
- lang: java
label: Java SDK
source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.types.ConfigurePropOpts;\n\npublic class Example {\n public static void main(String[] args) {\n BaseClient client = BaseClient\n .builder()\n .clientId(\"<clientId>\")\n .clientSecret(\"<clientSecret>\")\n .projectId(\"YOUR_PROJECT_ID\")\n .build();\n\n client.actions().configureProp(\n ConfigurePropOpts\n .builder()\n .id(\"id\")\n .externalUserId(\"external_user_id\")\n .propName(\"prop_name\")\n .build()\n );\n }\n}\n"
- lang: typescript
label: TypeScript SDK
source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n clientId: \"YOUR_CLIENT_ID\",\n clientSecret: \"YOUR_CLIENT_SECRET\",\n projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.actions.configureProp({\n id: \"id\",\n externalUserId: \"external_user_id\",\n propName: \"prop_name\"\n});\n"
- lang: python
label: Python SDK
source: "from pipedream import Pipedream\n\nclient = Pipedream(\n project_id=\"YOUR_PROJECT_ID\",\n project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.actions.configure_prop(\n id=\"id\",\n external_user_id=\"external_user_id\",\n prop_name=\"prop_name\",\n)\n"
tags:
- Actions
/v1/connect/{project_id}/actions/props:
parameters:
- name: project_id
in: path
required: true
description: The project ID, which starts with `proj_`.
schema:
type: string
pattern: ^proj_[a-zA-Z0-9]+$
x-fern-sdk-variable: project_id
post:
summary: Reload Action Props
operationId: reloadActionProps
x-fern-sdk-group-name: actions
x-fern-sdk-method-name: reloadProps
description: Reload the prop definition based on the currently configured props
security:
- ConnectToken: []
- OAuth2: []
parameters:
- name: x-pd-environment
in: header
required: true
description: The environment in which the server client is running
schema:
$ref: '#/components/schemas/ProjectEnvironment'
responses:
'200':
description: action props reloaded
content:
application/json:
schema:
$ref: '#/components/schemas/ReloadPropsResponse'
'202':
description: Async operation started
'429':
description: too many requests
headers:
Retry-After:
description: Number of seconds until the rate limit resets
schema:
type: integer
X-RateLimit-Limit:
schema:
type: integer
description: The rate limit threshold
X-RateLimit-Remaining:
schema:
type: integer
description: Number of requests remaining (always 0 when throttled)
X-RateLimit-Reset:
schema:
type: integer
description: Unix timestamp when the rate limit resets
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Throttled
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReloadPropsOpts'
x-codeSamples:
- lang: java
label: Java SDK
source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.types.ReloadPropsOpts;\n\npublic class Example {\n public static void main(String[] args) {\n BaseClient client = BaseClient\n .builder()\n .clientId(\"<clientId>\")\n .clientSecret(\"<clientSecret>\")\n .projectId(\"YOUR_PROJECT_ID\")\n .build();\n\n client.actions().reloadProps(\n ReloadPropsOpts\n .builder()\n .id(\"id\")\n .externalUserId(\"external_user_id\")\n .configuredProps(Map.of(\"key\", \"value\"))\n .build()\n );\n }\n}\n"
- lang: typescript
label: TypeScript SDK
source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n clientId: \"YOUR_CLIENT_ID\",\n clientSecret: \"YOUR_CLIENT_SECRET\",\n projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.actions.reloadProps({\n id: \"id\",\n externalUserId: \"external_user_id\",\n configuredProps: { key: \"value\" }\n});\n"
- lang: python
label: Python SDK
source: "from pipedream import Pipedream\n\nclient = Pipedream(\n project_id=\"YOUR_PROJECT_ID\",\n project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.actions.reload_props(\n id=\"id\",\n external_user_id=\"external_user_id\",\n configured_props={ \"key\": \"value\" },\n)\n"
tags:
- Actions
/v1/connect/{project_id}/actions/run:
parameters:
- name: project_id
in: path
required: true
description: The project ID, which starts with `proj_`.
schema:
type: string
pattern: ^proj_[a-zA-Z0-9]+$
x-fern-sdk-variable: project_id
post:
summary: Run Action
description: Execute an action with the provided configuration and return results
operationId: runAction
x-fern-sdk-group-name: actions
x-fern-sdk-method-name: run
security:
- ConnectToken: []
- OAuth2: []
parameters:
- name: x-pd-environment
in: header
required: true
description: The environment in which the server client is running
schema:
$ref: '#/components/schemas/ProjectEnvironment'
responses:
'200':
description: action ran
content:
application/json:
schema:
$ref: '#/components/schemas/RunActionResponse'
'202':
description: Async operation started
'429':
description: too many requests
headers:
Retry-After:
description: Number of seconds until the rate limit resets
schema:
type: integer
X-RateLimit-Limit:
schema:
type: integer
description: The rate limit threshold
X-RateLimit-Remaining:
schema:
type: integer
description: Number of requests remaining (always 0 when throttled)
X-RateLimit-Reset:
schema:
type: integer
description: Unix timestamp when the rate limit resets
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Throttled
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunActionOpts'
x-codeSamples:
- lang: java
label: Java SDK
source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.resources.actions.requests.RunActionOpts;\n\npublic class Example {\n public static void main(String[] args) {\n BaseClient client = BaseClient\n .builder()\n .clientId(\"<clientId>\")\n .clientSecret(\"<clientSecret>\")\n .projectId(\"YOUR_PROJECT_ID\")\n .build();\n\n client.actions().run(\n RunActionOpts\n .builder()\n .id(\"id\")\n .externalUserId(\"external_user_id\")\n .configuredProps(Map.of(\"key\", \"value\"))\n .build()\n );\n }\n}\n"
- lang: typescript
label: TypeScript SDK
source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n clientId: \"YOUR_CLIENT_ID\",\n clientSecret: \"YOUR_CLIENT_SECRET\",\n projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.actions.run({\n id: \"id\",\n externalUserId: \"external_user_id\",\n configuredProps: { key: \"value\" }\n});\n"
- lang: python
label: Python SDK
source: "from pipedream import Pipedream\n\nclient = Pipedream(\n project_id=\"YOUR_PROJECT_ID\",\n project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.actions.run(\n id=\"id\",\n external_user_id=\"external_user_id\",\n configured_props={ \"key\": \"value\" },\n)\n"
tags:
- Actions
components:
schemas:
ConfiguredPropValue:
oneOf:
- $ref: '#/components/schemas/ConfiguredPropValueAny'
- $ref: '#/components/schemas/ConfiguredPropValueApp'
- $ref: '#/components/schemas/ConfiguredPropValueBoolean'
- $ref: '#/components/schemas/ConfiguredPropValueInteger'
- $ref: '#/components/schemas/ConfiguredPropValueObject'
- $ref: '#/components/schemas/ConfiguredPropValueSql'
- $ref: '#/components/schemas/ConfiguredPropValueString'
- $ref: '#/components/schemas/ConfiguredPropValueStringArray'
ErrorResponse:
type: object
description: Error response returned by the API in case of an error
required:
- error
properties:
error:
type: string
description: The error message
code:
type: string
description: The error code
details:
type: object
description: Additional error details
ConfigurablePropStringArray:
allOf:
- $ref: '#/components/schemas/ConfigurablePropBase'
- type: object
description: This prop can accept an array of strings.
required:
- type
properties:
type:
type: string
enum:
- string[]
secret:
type:
- boolean
- 'null'
description: If true, this prop is a secret and should not be displayed in plain text.
format:
$ref: '#/components/schemas/ConfigurablePropStringFormat'
default:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConfiguredPropValueString'
description: The default value for this prop
options:
type: array
items:
anyOf:
- $ref: '#/components/schemas/PropOption'
- $ref: '#/components/schemas/PropOptionNested'
- $ref: '#/components/schemas/PropOptionValue'
Observation:
type: object
description: Any logs produced during the configuration of the prop
required:
- k
- ts
properties:
err:
$ref: '#/components/schemas/ObservationError'
k:
type: string
description: The source of the log (e.g. `console.log`)
msg:
type: string
description: The log message
ts:
type: number
description: The time at which the log was produced, as milliseconds since the epoch
ConfiguredPropValueApp:
type: object
required:
- authProvisionId
properties:
authProvisionId:
$ref: '#/components/schemas/AccountId'
ConfigurablePropAlert:
allOf:
- $ref: '#/components/schemas/ConfigurablePropBase'
- type: object
description: This prop is used to configure an alert component
required:
- type
- content
properties:
type:
type: string
enum:
- alert
alertType:
$ref: '#/components/schemas/ConfigurablePropAlertType'
content:
type: string
description: The content of the alert, which can include HTML or plain text.
ConfigurablePropDiscord:
allOf:
- $ref: '#/components/schemas/ConfigurablePropBase'
- type: object
description: For Discord components, this prop can accept a Discord channel ID.
required:
- type
properties:
type:
type: string
enum:
- $.discord.channel
ConfigurablePropAirtableBaseId:
allOf:
- $ref: '#/components/schemas/ConfigurablePropBase'
- type: object
description: This prop is used to select an Airtable base.
required:
- type
- appProp
properties:
type:
type: string
enum:
- $.airtable.baseId
appProp:
type: string
description: The name of the app prop that provides Airtable authentication
Component:
type: object
required:
- key
- name
- version
- configurable_props
properties:
key:
type: string
description: The key that uniquely identifies the component.
name:
type: string
description: 'The human-readable name of the component, e.g. ''GitLab: List Commits'''
version:
type: string
description: The latest version of the component, in SemVer format.
pattern: ^\d+.\d+.\d+$
configurable_props:
type: array
items:
$ref: '#/components/schemas/ConfigurableProp'
description:
type:
- string
- 'null'
description: A description of the component
component_type:
type:
- string
- 'null'
description: The type of component (trigger or action)
stash:
$ref: '#/components/schemas/ComponentStash'
annotations:
$ref: '#/components/schemas/ToolAnnotations'
PropOption:
type: object
description: A configuration option for a component's prop
required:
- label
- value
properties:
label:
type: string
description: The human-readable label for the option
value:
$ref: '#/components/schemas/PropOptionValue'
ConfigurablePropSql:
allOf:
- $ref: '#/components/schemas/ConfigurablePropBase'
- type: object
description: This prop is used to configure SQL queries.
required:
- type
properties:
type:
type: string
enum:
- sql
auth:
$ref: '#/components/schemas/ConfigurablePropSqlAuth'
default:
$ref: '#/components/schemas/ConfiguredPropValueSql'
options:
type: array
items:
anyOf:
- $ref: '#/components/schemas/PropOption'
- $ref: '#/components/schemas/PropOptionNested'
- $ref: '#/components/schemas/PropOptionValue'
ConfigurePropOpts:
type: object
description: Request options for configuring a component's prop
required:
- id
- external_user_id
- prop_name
properties:
id:
type: string
description: The component ID
version:
type:
- string
- 'null'
description: Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
example: 1.2.3
external_user_id:
type: string
description: The external user ID
prop_name:
type: string
description: The name of the prop to configure
blocking:
type: boolean
description: Whether this operation should block until completion
configured_props:
$ref: '#/components/schemas/ConfiguredProps'
dynamic_props_id:
type: string
description: The ID for dynamic props
page:
type: number
description: Page number for paginated results
prev_context:
type: object
description: Previous context for pagination
query:
type: string
description: Search query for filtering options
ConfigurablePropDiscordChannelArray:
allOf:
- $ref: '#/components/schemas/ConfigurablePropBase'
- type: object
description: This prop is used to select multiple Discord channels.
required:
- type
properties:
type:
type: string
enum:
- $.discord.channel[]
appProp:
type: string
description: The name of the app prop that provides Discord authentication
GetComponentsResponse:
type: object
description: Response received when retrieving a list of components
required:
- data
- page_info
properties:
data:
type: array
items:
$ref: '#/components/schemas/Component'
page_info:
$ref: '#/components/schemas/PageInfo'
ConfigurablePropHttpRequest:
allOf:
- $ref: '#/components/schemas/ConfigurablePropBase'
- type: object
description: This prop is used to configure an HTTP request with URL, method, headers, params, body, and authentication.
required:
- type
properties:
type:
type: string
enum:
- http_request
default:
$ref: '#/components/schemas/HttpRequestConfig'
ReloadPropsOpts:
type: object
description: Request options for reloading a component's props when dealing with dynamic props
required:
- id
- external_user_id
properties:
id:
type: string
description: The component ID
version:
type:
- string
- 'null'
description: Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
example: 1.2.3
external_user_id:
type: string
description: The external user ID
blocking:
type: boolean
description: Whether this operation should block until completion
configured_props:
$ref: '#/components/schemas/ConfiguredProps'
dynamic_props_id:
type: string
description: The ID for dynamic props
ConfigurablePropApp:
allOf:
- $ref: '#/components/schemas/ConfigurablePropBase'
- type: object
description: This prop is used to configure an account for a specific app
required:
- type
- app
properties:
type:
type: string
enum:
- app
app:
type: string
description: The name slug of the app, e.g. 'github', 'slack', etc. This is used to identify the app for which the account is being configured.
ConfigurablePropObject:
allOf:
- $ref: '#/components/schemas/ConfigurablePropBase'
- type: object
description: This prop can accept a set of key-value pairs.
required:
- type
properties:
type:
type: string
enum:
- object
default:
$ref: '#/components/schemas/ConfiguredPropValueObject'
options:
type: array
items:
anyOf:
- $ref: '#/components/schemas/PropOption'
- $ref: '#/components/schemas/PropOptionNested'
- $ref: '#/components/schemas/PropOptionValue'
ConfiguredProps:
type: object
description: The configured properties of the component
additionalProperties:
$ref: '#/components/schemas/ConfiguredPropValue'
ObservationError:
type: object
description: Details about an observed error message
properties:
name:
type: string
description: The name of the error/exception
message:
type: string
description: The error message
stack:
type: string
description: The stack trace of the error
ConfigurablePropDb:
all
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/openapi/pipedream-actions-api-openapi.yml