Retrieve action

cURL

curl --request GET \
  --url https://api.pipedream.com/v1/connect/{project_id}/actions/{component_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-pd-environment: <x-pd-environment>'

{
  "data": {
    "key": "<string>",
    "name": "<string>",
    "version": "<string>",
    "configurable_props": [
      {
        "name": "<string>",
        "type": "$.airtable.baseId",
        "label": "<string>",
        "description": "<string>",
        "optional": true,
        "disabled": true,
        "hidden": true,
        "remoteOptions": true,
        "useQuery": true,
        "reloadProps": true,
        "withLabel": true
      }
    ],
    "description": "<string>",
    "component_type": "<string>",
    "stash": "optional",
    "annotations": {
      "destructiveHint": true,
      "idempotentHint": true,
      "openWorldHint": true,
      "readOnlyHint": true,
      "title": "<string>"
    }
  }
}

GET

connect

{project_id}

actions

{component_id}

cURL

curl --request GET \
  --url https://api.pipedream.com/v1/connect/{project_id}/actions/{component_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-pd-environment: <x-pd-environment>'

{
  "data": {
    "key": "<string>",
    "name": "<string>",
    "version": "<string>",
    "configurable_props": [
      {
        "name": "<string>",
        "type": "$.airtable.baseId",
        "label": "<string>",
        "description": "<string>",
        "optional": true,
        "disabled": true,
        "hidden": true,
        "remoteOptions": true,
        "useQuery": true,
        "reloadProps": true,
        "withLabel": true
      }
    ],
    "description": "<string>",
    "component_type": "<string>",
    "stash": "optional",
    "annotations": {
      "destructiveHint": true,
      "idempotentHint": true,
      "openWorldHint": true,
      "readOnlyHint": true,
      "title": "<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

component_id

string

required

The key that uniquely identifies the component (e.g., 'slack-send-message')

project_id

string

required

The project ID, which starts with 'proj_'.

Query Parameters

version

string

Optional semantic version of the component to retrieve (for example '1.0.0')

Response

action retrieved

Response received when retrieving a specific component

data

object

required

Show child attributes

data.key

string

required

The key that uniquely identifies the component.

data.name

string

required

The human-readable name of the component, e.g. 'GitLab: List Commits'

data.version

string

required

The latest version of the component, in SemVer format.

data.configurable_props

object[]

required

Show child attributes

data.configurable_props.name

string

required

When building configuredProps, make sure to use this field as the key when setting the prop value

data.configurable_props.type

enum<string>

required

Available options:

$.airtable.baseId,

$.airtable.fieldId,

$.airtable.tableId,

$.airtable.viewId,

$.discord.channel,

$.discord.channel[],

$.interface.apphook,

$.interface.http,

$.interface.timer,

$.service.db,

alert,

any,

app,

boolean,

data_store,

dir,

http_request,

integer,

integer[],

object,

sql,

string,

string[]

data.configurable_props.label

string | null

Value to use as an input label. In cases where type is "app", should load the app via getApp, etc. and show app.name instead.

data.configurable_props.description

string | null

A description of the prop, shown to the user when configuring the component.

data.configurable_props.optional

boolean | null

If true, this prop does not need to be specified.

data.configurable_props.disabled

boolean | null

If true, this prop will be ignored.

data.configurable_props.hidden

boolean | null

If true, should not expose this prop to the user

data.configurable_props.remoteOptions

boolean | null

If true, call configureComponent for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options

data.configurable_props.useQuery

boolean | null

If true, calls to configureComponent for this prop support receiving a query parameter to filter remote options

data.configurable_props.reloadProps

boolean | null

If true, after setting a value for this prop, a call to reloadComponentProps is required as the component has dynamic configurable props dependent on this one

data.configurable_props.withLabel

boolean | null

If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label

data.description

string | null

A description of the component

data.component_type

string | null

The type of component (trigger or action)

data.stash

enum<string> | null

Indicates if a File Stash ID is optional or required to run the component

Available options:

optional,

required

data.annotations

object

Optional properties describing component behavior

Show child attributes

data.annotations.destructiveHint

boolean | null

If true, the component may perform destructive updates to its environment. If false, the component performs only additive updates.

data.annotations.idempotentHint

boolean | null

If true, calling the component repeatedly with the same arguments will have no additional effect on the its environment.

data.annotations.openWorldHint

boolean | null

If true, this component may interact with an “open world” of external entities. If false, the component's domain of interaction is closed. For example, the world of a web search component is open, whereas that of a memory component is not.

data.annotations.readOnlyHint

boolean | null

If true, the component does not modify its environment.

data.annotations.title

string | null

A human-readable title for the component.

List actions Configure action prop

⌘I

Tokens

Apps

Accounts

Components

Actions

Triggers

Component Configuration

Deployed Triggers

Authorizations

Headers

Path Parameters

Query Parameters

Response