Skip to main content
POST
/
v1
/
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

A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.

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

​
id
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

​
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