Skip to main content
cURL
curl --request POST \
 --url https://api.pipedream.com/v1/connect/{project_id}/triggers/props \
 --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",
 "blocking": true,
 "configured_props": {},
 "dynamic_props_id": "<string>"
}
'
{
 "observations": [
 {
 "k": "<string>",
 "ts": 123,
 "err": {
 "name": "<string>",
 "message": "<string>",
 "stack": "<string>"
 },
 "msg": "<string>"
 }
 ],
 "errors": [
 "<string>"
 ],
 "dynamicProps": {
 "id": "<string>",
 "configurableProps": [
 {
 "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"
 }
 ]
 }
}
POST
/
v1
/
connect
/
{project_id}
/
triggers
/
props
cURL
curl --request POST \
 --url https://api.pipedream.com/v1/connect/{project_id}/triggers/props \
 --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",
 "blocking": true,
 "configured_props": {},
 "dynamic_props_id": "<string>"
}
'
{
 "observations": [
 {
 "k": "<string>",
 "ts": 123,
 "err": {
 "name": "<string>",
 "message": "<string>",
 "stack": "<string>"
 },
 "msg": "<string>"
 }
 ],
 "errors": [
 "<string>"
 ],
 "dynamicProps": {
 "id": "<string>",
 "configurableProps": [
 {
 "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"
 }
 ]
 }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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 reloading a component's props when dealing with dynamic props

id
string
required

The component ID

external_user_id
string
required

The external user ID

version
string | null

Optional component version (in SemVer format, for example '1.0.0'), defaults to latest

Example:

"1.2.3"

blocking
boolean

Whether this operation should block until completion

configured_props
object

The configured properties of the component

dynamic_props_id
string

The ID for dynamic props

Response

trigger props reloaded

Response from reloading component props

observations
object[]
errors
string[]

Any errors that occurred during configuration

dynamicProps
object

Dynamic properties of a saved component

Was this page helpful?

⌘I

AltStyle によって変換されたページ (->オリジナル) /