Skip to main content
POST
/
v1
/
connect
/
{project_id}
/
triggers
/
configure
cURL
curl --request POST \
  --url https://api.pipedream.com/v1/connect/{project_id}/triggers/configure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-pd-environment: <x-pd-environment>' \
  --data '{
  "id": "<string>",
  "external_user_id": "<string>",
  "prop_name": "<string>",
  "blocking": true,
  "configured_props": {},
  "dynamic_props_id": "<string>",
  "page": 123,
  "prev_context": {},
  "query": "<string>"
}'
{
  "options": [
    {
      "label": "<string>",
      "value": "<any>"
    }
  ],
  "string_options": [
    "<string>"
  ],
  "observations": {},
  "context": {},
  "errors": [
    "<string>"
  ]
}

Authorizations

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 configuring a component's prop

id
string
required

The component ID

external_user_id
string
required

The external user ID

prop_name
string
required

The name of the prop to configure

blocking
boolean

Whether this operation should block until completion

configured_props
object

The configured properties for the component

dynamic_props_id
string

The ID for dynamic props

page
number

Page number for paginated results

prev_context
object

Previous context for pagination

query
string

Search query for filtering options

Response

trigger configuration started

Response received after configuring a component's prop

options
object[] | null

Available options (with labels) for the configured prop

string_options
string[] | null

Available options for the configured prop

observations
object | null

Any logs produced during the configuration of the prop

context
object | null

New context after configuring the prop

errors
string[]

Any errors that occurred during configuration