Skip to main content
POST
cURL
Run components by key, not by saved component ID. Referencing a component by its saved component ID (sc_…) is deprecated for new integrations. Publish the component (from the public registry, or privately as a custom tool) and pass its key as id: for example slack-send-message or ~/my-custom-action. When you need an exact version to stay fixed, pin it with key@version (for example ~/my-custom-action@0.1.2) or the version parameter.Saved component IDs keep working for components that are published to the public registry or published by your workspace for the request’s environment. A component that was created but never published cannot be run or configured by ID, and the API returns 403 with a message asking you to publish it first.
See Setting the polling interval for details on defining the schedule for polling-based triggers.
When you pass a webhook_url, Pipedream returns a signing key you can use to verify webhook signatures on incoming event deliveries.

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

Pattern: ^proj_[a-zA-Z0-9]+$

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
default:latest

Trigger component semantic version

Example:

"1.0.0"

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

Pattern: ^p_[a-zA-Z0-9]+
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