curl --request POST \
--url https://api.pipedream.com/v1/connect/{project_id}/actions/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>",
"version": "1.2.3",
"blocking": true,
"configured_props": {},
"dynamic_props_id": "<string>",
"page": 123,
"prev_context": {},
"query": "<string>"
}
'{
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"string_options": [
"<string>"
],
"observations": [
{
"k": "<string>",
"ts": 123,
"err": {
"name": "<string>",
"message": "<string>",
"stack": "<string>"
},
"msg": "<string>"
}
],
"context": {},
"errors": [
"<string>"
]
}Retrieve remote options for a given prop for a action
curl --request POST \
--url https://api.pipedream.com/v1/connect/{project_id}/actions/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>",
"version": "1.2.3",
"blocking": true,
"configured_props": {},
"dynamic_props_id": "<string>",
"page": 123,
"prev_context": {},
"query": "<string>"
}
'{
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"string_options": [
"<string>"
],
"observations": [
{
"k": "<string>",
"ts": 123,
"err": {
"name": "<string>",
"message": "<string>",
"stack": "<string>"
},
"msg": "<string>"
}
],
"context": {},
"errors": [
"<string>"
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The access token received from the authorization server in the OAuth 2.0 flow.
The environment in which the server client is running
development, production The project ID, which starts with proj_.
Request options for configuring a component's prop
The component ID
The external user ID
The name of the prop to configure
Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
"1.2.3"
Whether this operation should block until completion
The configured properties of the component
Show child attributes
The ID for dynamic props
Page number for paginated results
Previous context for pagination
Search query for filtering options
action configuration started
Response received after configuring a component's prop
Available options (with labels) for the configured prop
A configuration option for a component's prop
Show child attributes
Available options for the configured prop
Show child attributes
New context after configuring the prop
Any errors that occurred during configuration
Was this page helpful?