Skip to main content
POST
/
v1
/
connect
/
{project_id}
/
actions
/
run
cURL
curl --request POST \
  --url https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-pd-environment: <x-pd-environment>' \
  --data '
{
  "id": "<string>",
  "external_user_id": "<string>",
  "version": "1.2.3",
  "configured_props": {},
  "dynamic_props_id": "<string>",
  "stash_id": "<string>"
}
'
{
  "exports": "<unknown>",
  "os": "<unknown>",
  "ret": "<unknown>",
  "stash_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-pd-environment
enum<string>
required

The environment in which the server client is running The environment in which the server client is running

Available options:
development,
production

Path Parameters

​
project_id
string
required

The project ID, which starts with 'proj_'.

Body

application/json

Request options for running an action

​
id
string
required

The action component ID

​
external_user_id
string
required

The external user ID

​
version
string | null

Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest

Example:

"1.2.3"

​
configured_props
object

The configured properties of the component

​
dynamic_props_id
string

The ID for dynamic props

​
stash_id

The ID of the File Stash to use for syncing the action's /tmp directory, or either true or 'NEW' to create a new stash

Response

action ran

The response received after running an action. See https://pipedream.com/docs/components/api#returning-data-from-steps for more details.

​
exports
any

The key-value pairs resulting from calls to $.export

​
os
any

Any logs produced during the execution of the action

​
ret
any

The value returned by the action

​
stash_id
string | null

The ID of the File Stash