Ironclad ACTION
Get Workflow
Retrieves the full Ironclad workflow object, including its schema and current attribute keys and types. Use the returned schema to construct a valid
updates payload for Update Workflow Attributes. Run Search Workflows first to find a workflow ID. Example: set workflowId to "wf_xyz789" to retrieve a workflow with fields such as id, title, status, currentStep, and attributes (a map of attribute key → value). Use the optional fields param (e.g. "id,title,status") to return only specific top-level keys. See the documentation- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Ironclad account once, then configure and run Get Workflow from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "ironclad-get-workflow",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
ironclad: { authProvisionId: "apn_xxxxxxx" },
workflowId: "Workflow ID",
hydrateEntities: true,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "ironclad-get-workflow",
"configured_props": {
"ironclad": { "authProvisionId": "apn_xxxxxxx" },
"workflowId": "Workflow ID",
"hydrateEntities": true
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "ironclad",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "ironclad-get-workflow",
arguments: {
workflowId: "Workflow ID",
hydrateEntities: true,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
workflowId Workflow ID | string | The identifier of a workflow. Obtain via Search Workflows. Required Dynamic |
hydrateEntities Hydrate Entities | boolean | Whether to expand referenced entities in the response. Defaults to false. Optional |
fields Fields | string | Comma-separated list of top-level response keys to return (e.g. id,title,status). If omitted, the full response object is returned. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- ironclad-get-workflow
- Version
- 0.0.2
- App
- Ironclad
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗