v1

latestOpenAPI 3.0.42026-08-0462132372.2 KB

Deploy trigger

Deploy a trigger to listen for and emit events

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

Headers

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

The environment in which the server client is running

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"
      }
    ]
  }
}