Deploy trigger

cURL

curl --request POST \
  --url https://api.pipedream.com/v1/connect/{project_id}/triggers/deploy \
  --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>",
  "workflow_id": "<string>",
  "webhook_url": "<string>",
  "emit_on_deploy": true
}
'

{
  "data": {
    "id": "<string>",
    "owner_id": "<string>",
    "component_id": "<string>",
    "configurable_props": [
      {
        "name": "<string>",
        "type": "alert",
        "content": "<string>",
        "label": "<string>",
        "description": "<string>",
        "optional": true,
        "disabled": true,
        "hidden": true,
        "remoteOptions": true,
        "useQuery": true,
        "reloadProps": true,
        "withLabel": true,
        "alertType": "info"
      }
    ],
    "configured_props": {},
    "active": true,
    "created_at": 123,
    "updated_at": 123,
    "name": "<string>",
    "name_slug": "<string>",
    "type": "DeployedComponent",
    "component_key": "<string>",
    "callback_observations": "<unknown>",
    "emit_on_deploy": true
  }
}

POST

connect

{project_id}

triggers

deploy

cURL

curl --request POST \
  --url https://api.pipedream.com/v1/connect/{project_id}/triggers/deploy \
  --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>",
  "workflow_id": "<string>",
  "webhook_url": "<string>",
  "emit_on_deploy": true
}
'

{
  "data": {
    "id": "<string>",
    "owner_id": "<string>",
    "component_id": "<string>",
    "configurable_props": [
      {
        "name": "<string>",
        "type": "alert",
        "content": "<string>",
        "label": "<string>",
        "description": "<string>",
        "optional": true,
        "disabled": true,
        "hidden": true,
        "remoteOptions": true,
        "useQuery": true,
        "reloadProps": true,
        "withLabel": true,
        "alertType": "info"
      }
    ],
    "configured_props": {},
    "active": true,
    "created_at": 123,
    "updated_at": 123,
    "name": "<string>",
    "name_slug": "<string>",
    "type": "DeployedComponent",
    "component_key": "<string>",
    "callback_observations": "<unknown>",
    "emit_on_deploy": true
  }
}

See Setting the polling interval for details on defining the schedule for polling-based triggers.

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

Available options:

development,

production

Path Parameters

project_id

string

required

The project ID, which starts with proj_.

Body

application/json

Request options for deploying a trigger

string

required

The trigger component ID

external_user_id

string

required

The external user ID

version

string | null

Optional trigger 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

Show child attributes

configured_props.{key}

Show child attributes

configured_props.{key}.authProvisionId

string

required

The unique ID of the account.

dynamic_props_id

string

The ID for dynamic props

workflow_id

string

Optional ID of a workflow to receive trigger events

webhook_url

string

Optional webhook URL to receive trigger events

emit_on_deploy

boolean | null

Whether the trigger should emit events during the deploy hook execution. Defaults to true if not specified.

Response

trigger deployed

Response received after deploying a 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

A configuration or input field for a component. This is a discriminated union based on the type field.

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:

alert

data.configurable_props.content

string

required

The content of the alert, which can include HTML or plain text.

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.configurable_props.alertType

enum<string>

The severity level of the alert.

Available options:

info,

neutral,

warning,

error

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

data.emit_on_deploy

boolean

Whether the trigger emits events during the deploy hook execution. When false, the $emit function is disabled during deploy hook execution. Defaults to true.

Reload trigger props Configure component prop

⌘I

Tokens

Apps

Accounts

Components

Actions

Triggers

Component Configuration

Deployed Triggers

Manage Projects

Authorizations

Headers

Path Parameters

Body

Response