Run components by key, not by saved component ID. Referencing a component by its saved component ID (sc_…) is deprecated for new integrations. Publish the component (from the public registry, or privately as a custom tool) and pass its key as id: for example slack-send-message or ~/my-custom-action. When you need an exact version to stay fixed, pin it with key@version (for example ~/my-custom-action@0.1.2) or the version parameter.Saved component IDs keep working for components that are published to the public registry or published by your workspace for the request’s environment. A component that was created but never published cannot be run or configured by ID, and the API returns 403 with a message asking you to publish it first.
When an action fails, the response includes an error object with an attribution field that classifies where the error originated.See the docs on error responses for the full list of attribution origins and details on how attribution works.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pipedream","colors":{"primary":"#095c32","light":"#19f995","dark":"#0f9954"},"logo":{"light":"https://mintcdn.com/pipedream/J-J7n6QGsUEW1AZY/logo/pipedream_workday_lockup.png?fit=max\u0026auto=format\u0026n=J-J7n6QGsUEW1AZY\u0026q=85\u0026s=20f01e899a0e49424e3d16d1e84adc60","dark":"https://mintcdn.com/pipedream/J-J7n6QGsUEW1AZY/logo/pipedream_workday_lockup_dark.png?fit=max\u0026auto=format\u0026n=J-J7n6QGsUEW1AZY\u0026q=85\u0026s=cc9220550d73764499689dbac60a3615","href":"https://pipedream.com/docs"},"favicon":"https://mintcdn.com/pipedream/l2pOewTBZm3Zi3d2/logo/pipedream_icon.svg?fit=max\u0026auto=format\u0026n=l2pOewTBZm3Zi3d2\u0026q=85\u0026s=561dca46a7ea8017f3146eb1899554a6","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","typescript","python","java","go"]},"mdx":{"auth":{"method":"bearer"},"server":"https://api.pipedream.com/v1"}},"appearance":{"default":"system"},"background":{"decoration":"grid"},"navbar":{"links":[{"icon":"slack","href":"https://pipedream.com/join-slack","label":"Join community"}],"primary":{"type":"button","label":"Sign up for free","href":"https://pipedream.com/auth/signup"}},"footer":{"socials":{"github":"https://github.com/PipedreamHQ/pipedream","twitter":"https://twitter.com/pipedream","slack":"https://pipedream.com/join-slack"}},"seo":{"metatags":{"robots":"index, follow","charset":"UTF-8","viewport":"width=device-width, initial-scale=1.0","description":"Pipedream provides the toolkit to add thousands of integrations to your app and enables you to automate any process.","keywords":"api, mcp, ai, integrations, pipedream, workflow, automation, connect, apis","author":"Pipedream","googlebot":"index, follow","language":"en","og:type":"website","og:url":"https://pipedream.com","og:description":"Pipedream provides the toolkit to add thousands of integrations to your app and enables you to automate any process.","og:site_name":"Pipedream","og:locale":"en_US","twitter:card":"summary","twitter:site":"@pipedream","twitter:creator":"@pipedream","twitter:title":"Pipedream","twitter:description":"Pipedream provides the toolkit to add thousands of integrations to your app and enables you to automate any process.","twitter:image":"https://pipedream.com/image.jpg","twitter:image:alt":"Pipedream Logo","canonical":"https://pipedream.com/docs"}},"fonts":{"family":"Geist Sans","source":"https://cdn.jsdelivr.net/npm/geist@1.3.1/dist/fonts/geist-sans/Geist-Variable.woff2","format":"woff2"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pipedream","hasAudioNarration":false,"actualSubdomain":"pipedream","customDomains":["pipedream.com"],"gitSource":{"_id":"6ad7fa91692c7c940ff17a0e","type":"github","owner":"pipedreamhq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af639f1babeee4171cda659","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"Connect","count":218},{"language":"default","tag":"Documentation","count":126},{"language":"default","tag":"Conduit","count":77},{"language":"default","tag":"Connect API","count":63},{"language":"default","tag":"Workflows","count":62},{"language":"default","tag":"Guides","count":41},{"language":"default","tag":"Building Workflows","count":39},{"language":"default","tag":"API","count":35},{"language":"default","tag":"Write your own code","count":22},{"language":"default","tag":"Platform","count":21}]},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@pipedream.com"}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"68eabbe039150a938c8e901c","deploymentId":"6852099e30dd5c4192fd61e1","questionText":"How do I get started with Pipedream Connect?","status":"active","generatedBy":"manual","createdAt":"2025-10-11T20:19:44.842Z","updatedAt":"2025-10-11T20:19:44.842Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"styles/custom.css","content":"#banner{min-height:64px;display:flex;align-items:center;justify-content:center;gap:10px;padding:12px 24px;position:relative;background-color:rgba(239, 246, 255, 0.9)!important;border-top:1px solid rgb(191, 219, 254);border-bottom:1px solid rgb(191, 219, 254);box-shadow:0 1px 2px rgba(15, 23, 42, 0.08);transition:all 0.5s ease-out}:is(html.dark,body.dark) #banner{background-color:rgb(15, 23, 42)!important;border-top-color:rgb(51, 65, 85);border-bottom-color:rgb(51, 65, 85)}@media (max-width: 639px){#banner{flex-direction:row;align-items:center;gap:6px;padding:10px 10px}#banner::before{flex:0 0 auto;margin-right:2px}}#banner::before{content:\"\";width:120px;height:28px;background-image:url(\"https://pipedream.com/docs/images/wday_logo_no-TM_primary-RGB.svg\");background-size:contain;background-repeat:no-repeat;background-position:center;flex:0 0 auto}:is(html.dark,body.dark) #banner::before{background-image:url(\"https://pipedream.com/docs/images/wday_logo_no-TM_reversed-RGB.svg\")}@media (max-width: 639px){#banner::before{width:100px;height:24px}}#banner button{position:absolute;right:20px;top:50%;transform:translateY(-50%);padding:6px;border-radius:999px;color:rgb(37, 99, 235)!important;background:transparent;transition:color 0.2s ease, background-color 0.2s ease}#banner button svg{color:inherit;stroke:currentColor}#banner button:hover{background-color:rgba(191, 219, 254, 0.4);color:rgb(29, 78, 216)!important}:is(html.dark,body.dark) #banner button{color:rgb(191, 219, 254)!important}:is(html.dark,body.dark) #banner button:hover{background-color:rgba(51, 65, 85, 0.6);color:rgb(226, 232, 240)!important}@media (max-width: 639px){#banner button{top:12px;right:12px;transform:none}}#banner>div,#banner>div>p{display:flex!important;align-items:center;justify-content:center;flex-wrap:wrap;gap:6px;text-align:center;max-width:720px}#banner p{display:inline;margin:0}@media (max-width: 639px){#banner>div{width:100%;max-width:none;flex-direction:column;align-items:flex-start;justify-content:flex-start;gap:2px;text-align:left}#banner>div>p{display:block!important;width:100%;text-align:left}#banner p,#banner strong{text-align:left;line-height:1.3}}#banner,#banner *,#banner p,#banner strong,#banner p strong{color:rgb(71, 85, 105)!important;font-weight:500;font-size:1rem}#banner p strong{font-weight:500}:is(html.dark,body.dark) #banner,:is(html.dark,body.dark) #banner *,:is(html.dark,body.dark) #banner p,:is(html.dark,body.dark) #banner strong,:is(html.dark,body.dark) #banner p strong{color:rgb(219, 234, 254)!important}@media (min-width: 640px){#banner strong,#banner p strong{font-size:1.125rem}}#banner a[href*=\"newsroom.workday.com\"]:nth-of-type(1){display:inline-flex!important;align-items:center;justify-content:center;padding:8px 16px;height:36px;background-color:rgb(59, 130, 246);color:white!important;border-radius:6px;text-decoration:none!important;font-weight:500;font-size:1rem;transition:background-color 0.2s ease;margin-left:36px;flex-shrink:0;white-space:nowrap;box-shadow:0 1px 2px rgba(15, 23, 42, 0.12)}#banner a[href*=\"newsroom.workday.com\"]:nth-of-type(1):hover{background-color:rgb(29, 78, 216)}:is(html.dark,body.dark) #banner a[href*=\"newsroom.workday.com\"]:nth-of-type(1){background-color:rgb(59, 130, 246)}:is(html.dark,body.dark) #banner a[href*=\"newsroom.workday.com\"]:nth-of-type(1):hover{background-color:rgb(37, 99, 235)}@media (max-width: 639px){#banner a[href*=\"newsroom.workday.com\"]:nth-of-type(1){display:inline!important;align-self:flex-start;padding:0;height:auto;margin-left:0;background-color:transparent;color:rgb(37, 99, 235)!important;text-decoration:underline;text-decoration-thickness:1px;border-radius:0;box-shadow:none;white-space:normal}#banner a[href*=\"newsroom.workday.com\"]:nth-of-type(1):hover{background-color:transparent}}#banner-content{display:flex;align-items:center;gap:8px;flex-wrap:wrap;justify-content:center;text-align:center}.nav-logo{height:2.5rem}"}],"page":{"pagePath":"connect/api-reference/run-action","slug":"/connect/api-reference/run-action","pageMetadata":{"openapi":"post /v1/connect/{project_id}/actions/run","title":"Run action","description":"Execute an action with the provided configuration and return results","href":"/connect/api-reference/run-action"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Execute an action with the provided configuration and return results\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(Warning,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Run components by key, not by saved component ID.`}),` Referencing a component by its saved component ID (`,_jsx(_components.code,{children:`sc_…`}),`) is deprecated for new integrations. Publish the component (from the public registry, or `,_jsx(_components.a,{href:`/connect/components/custom-tools`,children:`privately as a custom tool`}),`) and pass its key as `,_jsx(_components.code,{children:`id`}),`: for example `,_jsx(_components.code,{children:`slack-send-message`}),` or `,_jsx(_components.code,{children:`~/my-custom-action`}),`. When you need an exact version to stay fixed, pin it with `,_jsx(_components.code,{children:`key@version`}),` (for example `,_jsx(_components.code,{children:`~/my-custom-action@0.1.2`}),`) or the `,_jsx(_components.code,{children:`version`}),` parameter.`]}),_jsxs(_components.p,{children:[`Saved component IDs keep working for components that are published to the public registry or published by your workspace for the request’s environment. A component that was created but never published cannot be run or configured by ID, and the API returns `,_jsx(_components.code,{children:`403`}),` with a message asking you to publish it first.`]})]}),`\n`,_jsx(Heading,{level:`3`,id:`error-handling`,children:`Error handling`}),`\n`,_jsx(_components.p,{children:`When an action fails, the response includes an error object with an attribution field that classifies where the error originated.`}),`\n`,_jsxs(_components.p,{children:[`See the docs on `,_jsx(_components.a,{href:`/connect/components/actions#error-responses`,children:`error responses`}),` for the full list of attribution origins and details on how attribution works.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v1/connect/{project_id}/actions/run","title":"Run action","description":"Execute an action with the provided configuration and return results","href":"/connect/api-reference/run-action"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Error handling","slug":"error-handling","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Run action","description":"Execute an action with the provided configuration and return results","operationId":"runAction","x-fern-sdk-group-name":"actions","x-fern-sdk-method-name":"run","security":["8eba5d94-a419-447c-915c-8aad0d461e97","5271742b-6ce8-4222-a0d7-d6d76a07c64f"],"parameters":["922a7339-08d0-46e4-a048-e6cf7f39643c"],"responses":{"200":"7aa2a271-ddc1-41c4-835c-d7fc51b14892","202":"c4582542-37bd-4562-b359-711ca85125be","429":"bea038b2-f9b8-4db4-aa4c-d7bf1b79c371"},"requestBody":"3d9b7812-3ee1-42e2-9289-52917a4aa38e","x-codeSamples":[{"lang":"java","label":"Java SDK","source":"package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.resources.actions.requests.RunActionOpts;\n\npublic class Example {\n public static void main(String[] args) {\n BaseClient client = BaseClient.withCredentials(\"\u003cclientId>\", \"\u003cclientSecret>\")\n .projectId(\"YOUR_PROJECT_ID\")\n .build()\n ;\n\n client.actions().run(\n RunActionOpts\n .builder()\n .id(\"id\")\n .externalUserId(\"external_user_id\")\n .configuredProps(Map.of(\"key\", \"value\"))\n .build()\n );\n }\n}\n"},{"lang":"python","label":"Python SDK","source":"from pipedream import Pipedream\n\nclient = Pipedream(\n project_id=\"YOUR_PROJECT_ID\",\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.actions.run(\n id=\"id\",\n external_user_id=\"external_user_id\",\n configured_props={ \"key\": \"value\" },\n)\n"},{"lang":"typescript","label":"TypeScript SDK","source":"import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n clientId: \"YOUR_CLIENT_ID\",\n clientSecret: \"YOUR_CLIENT_SECRET\",\n projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.actions.run({\n id: \"id\",\n externalUserId: \"external_user_id\",\n configuredProps: { key: \"value\" }\n});\n"}],"method":"post","type":"path","servers":["94d370e2-2341-427f-9133-eaddb7c7a172"],"path":"/v1/connect/{project_id}/actions/run","baseUrlOptions":["https://api.pipedream.com"],"title":"Run action","codeSamples":[{"label":"Java SDK","lang":"java","source":"package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.resources.actions.requests.RunActionOpts;\n\npublic class Example {\n public static void main(String[] args) {\n BaseClient client = BaseClient.withCredentials(\"\u003cclientId>\", \"\u003cclientSecret>\")\n .projectId(\"YOUR_PROJECT_ID\")\n .build()\n ;\n\n client.actions().run(\n RunActionOpts\n .builder()\n .id(\"id\")\n .externalUserId(\"external_user_id\")\n .configuredProps(Map.of(\"key\", \"value\"))\n .build()\n );\n }\n}\n"},{"label":"Python SDK","lang":"python","source":"from pipedream import Pipedream\n\nclient = Pipedream(\n project_id=\"YOUR_PROJECT_ID\",\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.actions.run(\n id=\"id\",\n external_user_id=\"external_user_id\",\n configured_props={ \"key\": \"value\" },\n)\n"},{"label":"TypeScript SDK","lang":"typescript","source":"import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n clientId: \"YOUR_CLIENT_ID\",\n clientSecret: \"YOUR_CLIENT_SECRET\",\n projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.actions.run({\n id: \"id\",\n externalUserId: \"external_user_id\",\n configuredProps: { key: \"value\" }\n});\n"}],"requestExampleLanguages":["bash","typescript","python","java","go"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"922a7339-08d0-46e4-a048-e6cf7f39643c":{"name":"x-pd-environment","in":"header","required":true,"description":"The environment in which the server client is running","schema":{"type":"string","description":"The environment in which the server client is running","enum":["development","production"],"isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"15dbdc51-3549-492e-a342-d722cd7852b7":{"name":"project_id","in":"path","required":true,"description":"The project ID, which starts with `proj_`.","schema":{"type":"string","pattern":"^proj_[a-zA-Z0-9]+$","isRequired":true,"description":"The project ID, which starts with `proj_`.","uniqueKey":"","typeLabel":"string"},"x-fern-sdk-variable":"project_id"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request options for running an action","required":["id","external_user_id"],"properties":{"id":{"type":"string","description":"The action component ID","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"external_user_id":{"type":"string","description":"The external user ID","isRequired":true,"uniqueKey":"external_user_id","typeLabel":"string"},"version":{"oneOf":[{"type":"string","description":"Action component semantic version","default":"latest","example":"1.0.0","uniqueKey":"version.oneOf.0","typeLabel":"string"},{"type":"null","description":"Action component semantic version","default":"latest","example":"1.0.0","uniqueKey":"version.oneOf.1","typeLabel":"null"}],"uniqueKey":"version","typeLabel":"string | null"},"configured_props":{"type":"object","description":"The configured properties of the component","additionalProperties":{"oneOf":[{"type":"object","required":["authProvisionId"],"properties":{"authProvisionId":{"type":"string","description":"The unique ID of the account.","pattern":"^apn_[a-zA-Z0-9]+$","isRequired":true,"uniqueKey":"configured_props.additionalProperties.oneOf.0.authProvisionId","typeLabel":"string"}},"uniqueKey":"configured_props.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"boolean","uniqueKey":"configured_props.additionalProperties.oneOf.1","typeLabel":"boolean"},{"type":"number","uniqueKey":"configured_props.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"object","required":["value","query","params","usePreparedStatements"],"properties":{"value":{"type":"string","description":"The raw SQL query, as provided by the user","isRequired":true,"uniqueKey":"configured_props.additionalProperties.oneOf.3.value","typeLabel":"string"},"query":{"type":"string","description":"The SQL query to execute","isRequired":true,"uniqueKey":"configured_props.additionalProperties.oneOf.3.query","typeLabel":"string"},"params":{"type":"array","description":"The list of parameters for the prepared statement","items":{"type":"string","uniqueKey":"configured_props.additionalProperties.oneOf.3.params.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"configured_props.additionalProperties.oneOf.3.params","typeLabel":"string[]"},"usePreparedStatements":{"type":"boolean","description":"Whether to use prepared statements for the query or not","isRequired":true,"uniqueKey":"configured_props.additionalProperties.oneOf.3.usePreparedStatements","typeLabel":"boolean"}},"uniqueKey":"configured_props.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"string","uniqueKey":"configured_props.additionalProperties.oneOf.4","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"configured_props.additionalProperties.oneOf.5.items.[INDEX]","typeLabel":"string"},"uniqueKey":"configured_props.additionalProperties.oneOf.5","typeLabel":"string[]"},{"type":"object","uniqueKey":"configured_props.additionalProperties.oneOf.6","typeLabel":"object"},{}],"uniqueKey":"configured_props.additionalProperties","typeLabel":"object · boolean · number · object · string · string[] · object"},"uniqueKey":"configured_props","typeLabel":"object"},"dynamic_props_id":{"type":"string","description":"The ID for dynamic props","uniqueKey":"dynamic_props_id","typeLabel":"string"},"stash_id":{"oneOf":[{"type":"string","description":"The ID of the File Stash to use for syncing the action's /tmp directory, or either `true` or 'NEW' to create a new stash","uniqueKey":"stash_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the File Stash to use for syncing the action's /tmp directory, or either `true` or 'NEW' to create a new stash","uniqueKey":"stash_id.oneOf.1","typeLabel":"null"},{"type":"string","description":"The ID of the File Stash to use for syncing the action's /tmp directory, or either `true` or 'NEW' to create a new stash","enum":["NEW"],"uniqueKey":"stash_id.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"boolean","description":"The ID of the File Stash to use for syncing the action's /tmp directory, or either `true` or 'NEW' to create a new stash","uniqueKey":"stash_id.oneOf.3","typeLabel":"boolean"},{"type":"null","uniqueKey":"stash_id.oneOf.4","typeLabel":"null"}],"uniqueKey":"stash_id","typeLabel":"string · null · enum\u003cstring> · boolean · null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","external_user_id":"\u003cstring>","version":"1.0.0","configured_props":{},"dynamic_props_id":"\u003cstring>","stash_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7aa2a271-ddc1-41c4-835c-d7fc51b14892":{"description":"action ran","content":{"application/json":{"schema":{"type":"object","description":"The response received after running an action. See https://pipedream.com/docs/components/api#returning-data-from-steps for more details.","properties":{"exports":{"type":"object","additionalProperties":true,"description":"The key-value pairs resulting from calls to `$.export`","uniqueKey":"exports","typeLabel":"object"},"os":{"type":"array","items":{"type":"object","description":"Any logs produced during the configuration of the prop","required":["k","ts"],"properties":{"k":{"type":"string","description":"The source of the log (e.g. `console.log`)","isRequired":true,"uniqueKey":"os.items.[INDEX].k","typeLabel":"string"},"ts":{"type":"number","description":"The time at which the log was produced, as milliseconds since the epoch","isRequired":true,"uniqueKey":"os.items.[INDEX].ts","typeLabel":"number"},"err":{"type":"object","description":"Details about an observed error message","properties":{"name":{"type":"string","description":"The name of the error/exception","uniqueKey":"os.items.[INDEX].err.name","typeLabel":"string"},"message":{"type":"string","description":"The error message","uniqueKey":"os.items.[INDEX].err.message","typeLabel":"string"},"stack":{"type":"string","description":"The stack trace of the error","uniqueKey":"os.items.[INDEX].err.stack","typeLabel":"string"}},"uniqueKey":"os.items.[INDEX].err","typeLabel":"object"},"msg":{"type":"string","description":"The log message","uniqueKey":"os.items.[INDEX].msg","typeLabel":"string"}},"uniqueKey":"os.items.[INDEX]","typeLabel":"object"},"description":"Any logs produced during the execution of the action","uniqueKey":"os","typeLabel":"object[]"},"ret":{"oneOf":[{"description":"The value returned by the action","uniqueKey":"ret.oneOf.0","typeLabel":"any"},{"description":"The value returned by the action","type":"null","uniqueKey":"ret.oneOf.1","typeLabel":"null"}],"uniqueKey":"ret","typeLabel":"any | null"},"stash_id":{"oneOf":[{"type":"string","description":"The ID of the File Stash","uniqueKey":"stash_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the File Stash","uniqueKey":"stash_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"stash_id","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"exports":{},"os":[{"k":"\u003cstring>","ts":123,"err":{"name":"\u003cstring>","message":"\u003cstring>","stack":"\u003cstring>"},"msg":"\u003cstring>"}],"ret":"\u003cunknown>","stash_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c4582542-37bd-4562-b359-711ca85125be":{"description":"Async operation started","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"bea038b2-f9b8-4db4-aa4c-d7bf1b79c371":{"description":"too many requests","headers":{"Retry-After":{"description":"Number of seconds until the rate limit resets","schema":{"type":"integer"}},"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"The rate limit threshold"},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Number of requests remaining (always 0 when throttled)"},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Unix timestamp when the rate limit resets"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Throttled","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Throttled"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8eba5d94-a419-447c-915c-8aad0d461e97":{"ConnectToken":{"description":"A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.","type":"http","scheme":"bearer","bearerFormat":"^ctok_[0-9a-f]{32}$","scopes":[],"schemeName":"ConnectToken"}},"5271742b-6ce8-4222-a0d7-d6d76a07c64f":{"OAuth2":{"description":"A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.pipedream.com/v1/oauth/token","scopes":{"*":"Full access to every OAuth-protected endpoint.","connect:*":"Full access to all Connect API endpoints (components, projects, triggers, accounts, etc.).","connect:actions:*":"Full access to Connect actions.","connect:triggers:*":"Full access to Connect triggers.","connect:accounts:read":"List and fetch Connect accounts for an external user.","connect:accounts:write":"Create or remove Connect accounts.","connect:deployed_triggers:read":"Read deployed triggers and related data like events, pipelines and webhooks.","connect:deployed_triggers:write":"Modify or delete deployed triggers.","connect:users:read":"List and fetch external users","connect:users:write":"Delete external users.","connect:projects:read":"List and fetch projects owned by the workspace.","connect:projects:write":"Create, update, or delete projects owned by the workspace.","connect:oauth_apps:read":"List and fetch custom OAuth clients, and fetch Pipedream official clients.","connect:oauth_apps:write":"Create, update, or delete custom OAuth clients.","connect:app_overrides:read":"List and fetch app overrides.","connect:app_overrides:write":"Create, update, or delete app overrides.","connect:usage:read":"List Connect usage records for a time window.","connect:tokens:create":"Create Connect session tokens.","connect:proxy":"Invoke the Connect proxy.","connect:workflow:invoke":"Invoke Connect workflows on behalf of a user."}}},"scopes":[],"schemeName":"OAuth2"}}},"servers":{"94d370e2-2341-427f-9133-eaddb7c7a172":{"url":"https://api.pipedream.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.","type":"http","scheme":"bearer","bearerFormat":"^ctok_[0-9a-f]{32}$","scopes":[],"schemeName":"ConnectToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ConnectToken","name":"Authorization"}],"title":"ConnectToken"},{"schemes":[{"scheme":{"description":"A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.pipedream.com/v1/oauth/token","scopes":{"*":"Full access to every OAuth-protected endpoint.","connect:*":"Full access to all Connect API endpoints (components, projects, triggers, accounts, etc.).","connect:actions:*":"Full access to Connect actions.","connect:triggers:*":"Full access to Connect triggers.","connect:accounts:read":"List and fetch Connect accounts for an external user.","connect:accounts:write":"Create or remove Connect accounts.","connect:deployed_triggers:read":"Read deployed triggers and related data like events, pipelines and webhooks.","connect:deployed_triggers:write":"Modify or delete deployed triggers.","connect:users:read":"List and fetch external users","connect:users:write":"Delete external users.","connect:projects:read":"List and fetch projects owned by the workspace.","connect:projects:write":"Create, update, or delete projects owned by the workspace.","connect:oauth_apps:read":"List and fetch custom OAuth clients, and fetch Pipedream official clients.","connect:oauth_apps:write":"Create, update, or delete custom OAuth clients.","connect:app_overrides:read":"List and fetch app overrides.","connect:app_overrides:write":"Create, update, or delete app overrides.","connect:usage:read":"List Connect usage records for a time window.","connect:tokens:create":"Create Connect session tokens.","connect:proxy":"Invoke the Connect proxy.","connect:workflow:invoke":"Invoke Connect workflows on behalf of a user."}}},"scopes":[],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"pipedream_openapi_swagger.json"},"subdomain":"pipedream","siteName":"Pipedream","title":"Run action - Pipedream","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T21:23:20.532Z","originalFileLocation":"connect/api-reference/run-action.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Execute an action with the provided configuration and return results\">\u003cmeta data-mint-head name=\"keywords\" content=\"api, mcp, ai, integrations, pipedream, workflow, automation, connect, apis\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pipedream\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run action - Pipedream\">\u003cmeta data-mint-head property=\"og:description\" content=\"Pipedream provides the toolkit to add thousands of integrations to your app and enables you to automate any process.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pipedream\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://pipedream.com/docs/connect/api-reference/run-action\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pipedream.mintlify.site/docs/_mintlify/api/og/v2?division=Actions\u0026amp;title=Run+action\u0026amp;description=Execute+an+action+with+the+provided+configuration+and+return+results\u0026amp;theme=772f5b43afb7c4ed70f0402c\u0026amp;signature=cf272cdf17c9a69a556c15e19628dbe0fc8717ce74881e41e25d408e17c50ac8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Pipedream\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Pipedream provides the toolkit to add thousands of integrations to your app and enables you to automate any process.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pipedream.mintlify.site/docs/_mintlify/api/og/v2?division=Actions\u0026amp;title=Run+action\u0026amp;description=Execute+an+action+with+the+provided+configuration+and+return+results\u0026amp;theme=772f5b43afb7c4ed70f0402c\u0026amp;signature=cf272cdf17c9a69a556c15e19628dbe0fc8717ce74881e41e25d408e17c50ac8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/pipedream/BXAUbH3bs99htewI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pipedream\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#095c32\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"charset\" content=\"UTF-8\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"author\" content=\"Pipedream\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@pipedream\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Pipedream Logo\">\u003clink data-mint-head rel=\"canonical\" href=\"https://pipedream.com/docs/connect/api-reference/run-action\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/connect/api-reference/run-action.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://pipedream.com/#organization\",\"name\":\"Pipedream\",\"url\":\"https://pipedream.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pipedream/J-J7n6QGsUEW1AZY/logo/pipedream_workday_lockup.png?fit=max\u0026auto=format\u0026n=J-J7n6QGsUEW1AZY\u0026q=85\u0026s=20f01e899a0e49424e3d16d1e84adc60\"}},{\"@type\":\"WebSite\",\"@id\":\"https://pipedream.com/docs#website\",\"name\":\"Pipedream\",\"url\":\"https://pipedream.com/docs\",\"publisher\":{\"@id\":\"https://pipedream.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://pipedream.com/docs/connect/api-reference/run-action#webpage\",\"url\":\"https://pipedream.com/docs/connect/api-reference/run-action\",\"name\":\"Run action\",\"description\":\"Execute an action with the provided configuration and return results\",\"dateModified\":\"2026-11-03T21:23:20.532Z\",\"isPartOf\":{\"@id\":\"https://pipedream.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://pipedream.com/docs/connect/api-reference/run-action#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://pipedream.com/docs/connect/api-reference/run-action#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Actions\",\"item\":\"https://pipedream.com/docs/connect/api-reference/list-actions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run action\",\"item\":\"https://pipedream.com/docs/connect/api-reference/run-action\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://pipedream.com/docs/connect/api-reference/run-action#apireference\",\"headline\":\"Run action\",\"name\":\"Run action\",\"description\":\"Execute an action with the provided configuration and return results\",\"url\":\"https://pipedream.com/docs/connect/api-reference/run-action\",\"mainEntityOfPage\":{\"@id\":\"https://pipedream.com/docs/connect/api-reference/run-action#webpage\"},\"dateModified\":\"2026-11-03T21:23:20.532Z\",\"publisher\":{\"@id\":\"https://pipedream.com/#organization\"},\"isPartOf\":{\"@id\":\"https://pipedream.com/docs#website\"}}]}\u003c/script>","agentPointerHref":"/docs/connect/api-reference/run-action.md","siteName":"Pipedream","nav":{"global":null,"products":[{"product":"Connect","icon":"https://mintlify.s3.us-west-1.amazonaws.com/pipedream/logo/pipedream_icon.svg","description":"Integration layer for AI agents","tabs":[{"tab":"Documentation","icon":"book","pages":[{"title":"Documentation","href":""}]},{"tab":"Connect API","icon":"square-terminal","pages":[{"title":"Introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/connect/api-reference/introduction"},{"title":"SDKs","icon":"layer-group","href":"/connect/api-reference/sdks"},{"title":"Authentication","sidebarTitle":"Authentication","icon":"lock","href":"/connect/api-reference/authentication"},{"title":"Rate Limits","sidebarTitle":"Rate Limits","icon":"gauge","href":"/connect/api-reference/rate-limits"},{"title":"SDK Migration Guide","icon":"swap","href":"/connect/api-reference/sdk-migration"},{"group":"Tokens","pages":[{"openapi":"post /v1/oauth/token","title":"Generate OAuth Token","href":"/connect/api-reference/create-oauth-token"},{"title":"Create Connect token","openapi":"post /v1/connect/{project_id}/tokens","href":"/connect/api-reference/create-connect-token"}]},{"group":"Apps","pages":[{"openapi":"get /v1/connect/apps","title":"List apps","href":"/connect/api-reference/list-apps"},{"openapi":"get /v1/connect/apps/{app_id}","title":"Retrieve app","href":"/connect/api-reference/retrieve-app"},{"openapi":"get /v1/connect/app_categories","title":"List app categories","href":"/connect/api-reference/list-app-categories"}]},{"group":"Accounts","pages":[{"title":"List user accounts","openapi":"get /v1/connect/{project_id}/users/{external_user_id}/accounts","href":"/connect/api-reference/list-accounts-for-external-user"},{"openapi":"get /v1/connect/{project_id}/accounts/{account_id}","title":"Retrieve account","href":"/connect/api-reference/retrieve-account"},{"openapi":"delete /v1/connect/{project_id}/accounts/{account_id}","title":"Delete account","href":"/connect/api-reference/delete-account"},{"openapi":"delete /v1/connect/{project_id}/apps/{app_id}/accounts","title":"Delete accounts by app","href":"/connect/api-reference/delete-accounts-by-app"}]},{"group":"External Users","pages":[{"title":"List external users","openapi":"get /v1/connect/{project_id}/users","href":"/connect/api-reference/list-users"},{"openapi":"delete /v1/connect/{project_id}/users/{external_user_id}","title":"Delete external user","href":"/connect/api-reference/delete-external-user"}]},{"group":"Actions","pages":[{"openapi":"get /v1/connect/{project_id}/actions","title":"List actions","href":"/connect/api-reference/list-actions"},{"openapi":"get /v1/connect/{project_id}/actions/{component_id}","title":"Retrieve action","href":"/connect/api-reference/retrieve-action"},{"openapi":"post /v1/connect/{project_id}/actions/configure","title":"Configure action prop","href":"/connect/api-reference/configure-action-prop"},{"openapi":"post /v1/connect/{project_id}/actions/props","title":"Reload action props","description":"Reload the prop definition based on the currently configured props","href":"/connect/api-reference/reload-action-props"},{"openapi":"post /v1/connect/{project_id}/actions/run","title":"Run action","href":"/connect/api-reference/run-action"}]},{"group":"Triggers","pages":[{"openapi":"get /v1/connect/{project_id}/triggers","title":"List triggers","description":"Retrieve available triggers with optional search and app filtering","href":"/connect/api-reference/list-triggers"},{"openapi":"get /v1/connect/{project_id}/triggers/{component_id}","title":"Retrieve trigger","href":"/connect/api-reference/retrieve-trigger"},{"openapi":"post /v1/connect/{project_id}/triggers/configure","title":"Configure trigger prop","href":"/connect/api-reference/configure-trigger-prop"},{"openapi":"post /v1/connect/{project_id}/triggers/props","title":"Reload trigger props","href":"/connect/api-reference/reload-trigger-props"},{"openapi":"post /v1/connect/{project_id}/triggers/deploy","title":"Deploy trigger","href":"/connect/api-reference/deploy-trigger"}]},{"group":"Deployed Triggers","pages":[{"openapi":"get /v1/connect/{project_id}/deployed-triggers","title":"List deployed triggers","href":"/connect/api-reference/list-deployed-triggers"},{"openapi":"get /v1/connect/{project_id}/deployed-triggers/{trigger_id}","title":"Get deployed trigger","href":"/connect/api-reference/get-deployed-trigger"},{"openapi":"put /v1/connect/{project_id}/deployed-triggers/{trigger_id}","title":"Update deployed trigger","href":"/connect/api-reference/update-deployed-trigger"},{"openapi":"delete /v1/connect/{project_id}/deployed-triggers/{trigger_id}","title":"Delete deployed trigger","href":"/connect/api-reference/delete-deployed-trigger"},{"openapi":"get /v1/connect/{project_id}/deployed-triggers/{trigger_id}/events","title":"List trigger events","href":"/connect/api-reference/list-trigger-events"},{"openapi":"get /v1/connect/{project_id}/deployed-triggers/{trigger_id}/webhooks","title":"List trigger webhooks","href":"/connect/api-reference/list-trigger-webhooks"},{"openapi":"get /v1/connect/{project_id}/deployed-triggers/{trigger_id}/webhooks/{webhook_id}","title":"Get trigger webhook","href":"/connect/api-reference/get-trigger-webhook"},{"openapi":"put /v1/connect/{project_id}/deployed-triggers/{trigger_id}/webhooks","title":"Update trigger webhooks","href":"/connect/api-reference/update-trigger-webhooks"},{"openapi":"post /v1/connect/{project_id}/deployed-triggers/{trigger_id}/webhooks/{webhook_id}/regenerate_signing_key","title":"Regenerate trigger webhook signing key","href":"/connect/api-reference/regenerate-trigger-webhook-signing-key"},{"openapi":"post /v1/connect/{project_id}/deployed-triggers/{trigger_id}/webhooks/{webhook_id}/reset_delivery_state","title":"Reset trigger webhook delivery state","href":"/connect/api-reference/reset-trigger-webhook-delivery-state"}]},{"group":"Components","pages":[{"openapi":"get /v1/connect/{project_id}/components","title":"List components","href":"/connect/api-reference/list-components"},{"openapi":"get /v1/connect/{project_id}/components/{component_id}","title":"Retrieve component","href":"/connect/api-reference/retrieve-component"},{"openapi":"post /v1/connect/{project_id}/components/configure","title":"Configure component prop","href":"/connect/api-reference/configure-component-prop"},{"openapi":"post /v1/connect/{project_id}/components/props","title":"Reload component props","href":"/connect/api-reference/reload-component-props"}]},{"group":"OAuth Clients","pages":[{"openapi":"get /v1/connect/{project_id}/oauth_apps","title":"List OAuth clients","href":"/connect/api-reference/list-oauth-clients"},{"openapi":"post /v1/connect/{project_id}/oauth_apps","title":"Create OAuth client","href":"/connect/api-reference/create-oauth-client"},{"openapi":"get /v1/connect/{project_id}/oauth_apps/{id}","title":"Retrieve OAuth client","href":"/connect/api-reference/retrieve-oauth-client"},{"openapi":"put /v1/connect/{project_id}/oauth_apps/{id}","title":"Update OAuth client","href":"/connect/api-reference/update-oauth-client"},{"openapi":"delete /v1/connect/{project_id}/oauth_apps/{id}","title":"Delete OAuth client","href":"/connect/api-reference/delete-oauth-client"}]},{"group":"App Overrides","pages":[{"openapi":"get /v1/connect/{project_id}/app_overrides","title":"List app overrides","href":"/connect/api-reference/list-app-overrides"},{"openapi":"post /v1/connect/{project_id}/app_overrides","title":"Create app override","href":"/connect/api-reference/create-app-override"},{"openapi":"get /v1/connect/{project_id}/app_overrides/{id}","title":"Retrieve app override","href":"/connect/api-reference/retrieve-app-override"},{"openapi":"put /v1/connect/{project_id}/app_overrides/{id}","title":"Update app override","href":"/connect/api-reference/update-app-override"},{"openapi":"delete /v1/connect/{project_id}/app_overrides/{id}","title":"Delete app override","href":"/connect/api-reference/delete-app-override"}]},{"group":"Projects","pages":[{"openapi":"get /v1/connect/projects","title":"List projects","href":"/connect/api-reference/list-projects"},{"openapi":"post /v1/connect/projects","title":"Create project","href":"/connect/api-reference/create-project"},{"openapi":"get /v1/connect/projects/{project_id}","title":"Retrieve project","href":"/connect/api-reference/retrieve-project"},{"openapi":"patch /v1/connect/projects/{project_id}","title":"Update project","href":"/connect/api-reference/update-project"},{"openapi":"delete /v1/connect/projects/{project_id}","title":"Delete project","href":"/connect/api-reference/delete-project"},{"openapi":"post /v1/connect/projects/{project_id}/logo","title":"Update project logo","href":"/connect/api-reference/update-project-logo"},{"openapi":"get /v1/connect/{project_id}/projects/info","title":"Get project info","href":"/connect/api-reference/get-project-info"}]},{"group":"Project Webhooks","pages":[{"openapi":"get /v1/connect/{project_id}/webhook","title":"Get project environment webhook","href":"/connect/api-reference/get-project-environment-webhook"},{"openapi":"put /v1/connect/{project_id}/webhook","title":"Set project environment webhook","href":"/connect/api-reference/set-project-environment-webhook"},{"openapi":"delete /v1/connect/{project_id}/webhook","title":"Delete project environment webhook","href":"/connect/api-reference/delete-project-environment-webhook"},{"openapi":"post /v1/connect/{project_id}/webhook/regenerate_signing_key","title":"Regenerate webhook signing key","href":"/connect/api-reference/regenerate-webhook-signing-key"}]},{"group":"Connect Usage","pages":[{"openapi":"get /v1/connect/usage","title":"List usage records","href":"/connect/api-reference/list-usage-records"}]},{"group":"File Stash","pages":[{"openapi":"get /v1/connect/{project_id}/file_stash/download","title":"Download file","href":"/connect/api-reference/download-file"}]}]},{"tab":"Changelog","icon":"bullhorn","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"product":"Conduit","icon":"https://mintlify.s3.us-west-1.amazonaws.com/pipedream/images/conduit/conduit-mark.svg","description":"Enterprise MCP Gateway","pages":[{"title":"Conduit","href":"/conduit"}]}]},"basePath":"","title":"Run action - Pipedream","buildId":"dpl_FGqRJUoJWfds4SqdfFGJ2v1vVNSs","deploymentId":"dpl_FGqRJUoJWfds4SqdfFGJ2v1vVNSs","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Us8B4Mzf.js","utils-Dv2Wyxzv.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CLOEZoDv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-xCe08nEy.js","snippetPresets-Cc_giFbY.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DafA3CKm.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DsvMszM5.js","shallow-DfieQrKJ.js","getApiPlaygroundDisplay-BgvbqFlL.js","CodeSnippet-DFJsVHka.js","CodeSnippets-CcVa6za-.js","Page-7I7jezgZ.js","getPastedJson-MHp3jc8Z.js","icon-CUK0uq79.js","MethodPill-BXkAvnAk.js","DuplicateIcon-C9TFiQKm.js","createIcon-d5a1ep-A.js","DynamicMarkdown-v9H593Hz.js","SectionHeading-cxpy1bWG.js","axios-vUo_bRtp.js","Markdown-DpEtVC-e.js","clsx-DHc1bJzL.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Ct9D9ps9.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DuOJEEJm.js"]}