View as Markdown
Ironclad icon

Ironclad ACTION

Launch Workflow

Launches a new workflow in Ironclad. Run Describe Workspace to find a template ID, then run Describe Workflow Template to discover the field keys, types, and constraints (including conditional fields) needed to build the attributes payload. Example: set templateId to "tmpl_abc123" and attributes to {"counterpartyName": "Acme Corp", "paperSource": "Our paper", "startDate": "2026-09-01"}; returns {"id": "wf_xyz789", "status": "review"}. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ironclad account once, then configure and run Launch 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-launch-workflow",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ironclad: { authProvisionId: "apn_xxxxxxx" },
    templateId: "Template ID",
    attributes: "Attributes",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Launch Workflow inputs
Property Type Description
templateId Template ID string
The identifier of a workflow template. Obtain via Describe Workspace (e.g. tmpl_abc123).
Required Dynamic
attributes Attributes string
JSON object of workflow field key to value pairs. Run Describe Workflow Template first to discover valid keys, types, and required fields — including any fields whose required is "conditional" (a dependsOn hint shows which other field's value triggers the requirement, when inferable). Complex types use nested objects: monetaryAmount {"currency": "USD", "amount": 25.37}, date "2021-05-11T17:16:53-07:00", address {"lines": ["325 5th Street", "Suite 200"], "locality": "San Francisco", "region": "California", "postcode": "94107", "country": "USA"}, duration {"years": 1, "months": 2, "weeks": 3, "days": 4}. A document array field (e.g. draft) takes [{"url": "..."}] — Ironclad fetches this URL server-side, so the URL must be a real, publicly-reachable file (not a placeholder or made-up domain — a fabricated URL fails with CONTENT_UNAVAILABLE). Example: {"counterpartyName": "Acme Corp", "paperSource": "Our paper", "startDate": "2026-09-01"}.
Required
useDefaultValues Use Default Values boolean
Whether to populate unset fields with the template's default values. Defaults to true.
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-launch-workflow
Version
1.0.1
App
Ironclad
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes