PIpipedream

Deploy trigger

Deploy a trigger to listen for and emit events

post/v1/connect/{project_id}/triggers/deploy

Request

  • Base URL
    https://api.pipedream.com
  • URL
    https://api.pipedream.com/v1/connect/{project_id}/triggers/deploy
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://api.pipedream.com/v1/oauth/token

Headers

x-pd-environment'development' | 'production' required

The environment in which the server client is running

Request body

idstring required

The trigger component ID

versionstring nullable

Trigger component semantic version

external_user_idstring required

The external user ID

configured_propsConfiguredProps

The configured properties of the component

dynamic_props_idstring

The ID for dynamic props

workflow_idstring

Optional ID of a workflow to receive trigger events

webhook_urlstring

Optional webhook URL to receive trigger events

emit_on_deployboolean nullable

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

Example request

{
  "version": "1.0.0"
}

Response

trigger deployed

Example response

{
  "data": {
    "configurable_props": [
      {
        "app": "github"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.