Get deployed trigger

cURL

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

{
  "data": {
    "id": "<string>",
    "owner_id": "<string>",
    "component_id": "<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
      }
    ],
    "configured_props": {},
    "active": true,
    "created_at": 123,
    "updated_at": 123,
    "name": "<string>",
    "name_slug": "<string>",
    "type": "DeployedComponent",
    "component_key": "<string>",
    "callback_observations": "<unknown>"
  }
}

GET

connect

{project_id}

deployed-triggers

{trigger_id}

cURL

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

{
  "data": {
    "id": "<string>",
    "owner_id": "<string>",
    "component_id": "<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
      }
    ],
    "configured_props": {},
    "active": true,
    "created_at": 123,
    "updated_at": 123,
    "name": "<string>",
    "name_slug": "<string>",
    "type": "DeployedComponent",
    "component_key": "<string>",
    "callback_observations": "<unknown>"
  }
}

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_'.

trigger_id

string

required

Query Parameters

external_user_id

string

required

Your end user ID, for whom you deployed the trigger

Response

deployed trigger retrieved

Response received when retrieving a deployed trigger

data

object

required

A component/interface that emits events

Option 1
Option 2
Option 3

Show child attributes

data.id

string

required

The unique ID of the deployed component

data.owner_id

string

required

The ID of the owner

data.component_id

string

required

The ID of the component that was deployed

data.configurable_props

object[]

required

The configurable properties of the component

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.configured_props

object

required

The configured properties of the component

Show child attributes

data.configured_props.{key}

Show child attributes

data.configured_props.{key}.authProvisionId

string

required

The unique ID of the account.

data.active

boolean

required

Whether the deployed component is active

data.created_at

integer

required

The timestamp when the component was deployed (epoch milliseconds)

data.updated_at

integer

required

The timestamp when the component was last updated (epoch milliseconds)

data.name

string

required

The name of the deployed component

data.name_slug

string

required

The name slug of the deployed component

data.type

enum<string>

required

The discriminator field

Available options:

DeployedComponent

data.component_key

string | null

The component key (name) that was deployed

data.callback_observations

any | null

Callback observations for the deployed component

List deployed triggers Update deployed trigger

⌘I

Tokens

Apps

Accounts

Components

Actions

Triggers

Component Configuration

Deployed Triggers

Get deployed trigger

Authorizations

Headers

Path Parameters

Query Parameters

Response