View as Markdown
Ironclad icon

Ironclad ACTION

Describe Workflow Template

Retrieves the fillable attribute schema for an Ironclad workflow template — the required call before Launch Workflow. Returns each field's type, display name, enum options, and whether it's required. Every field's description already includes a worked value-format example for complex types (address, monetaryAmount, date, duration, document/array) — use those examples verbatim, do not guess a shape. A field's required may be "conditional": when Ironclad's naming convention makes the trigger inferable (e.g. a field named set1Question2 triggered by a selector field set to "Set 1"), a dependsOn: {field, value} hint is included; whenever you set the selector to that value, also include the dependent field. If a conditional field has no dependsOn hint, its trigger isn't inferable from naming — watch for a MISSING_PARAM error naming it after you submit Launch Workflow, and retry with it included. Run Describe Workspace first to find a template ID. Example: set templateId to "tmpl_abc123" to retrieve a schema where each field looks like {"counterpartyName": {"type": "string", "displayName": "Counterparty Name", "required": "always", "description": "Value of Counterparty Name"}, "requiredAddress": {"type": "address", "displayName": "Required Address", "required": "always", "description": "Value of Required Address. Example: {\"lines\": [...], \"locality\": ..., \"region\": ..., \"postcode\": ..., \"country\": ...}"}}. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

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.

Describe Workflow Template inputs
Property Type Description
templateId Template ID string
The identifier of a workflow template. Obtain via Describe Workspace (e.g. tmpl_abc123).
Required Dynamic

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-describe-workflow-template
Version
0.0.2
App
Ironclad
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes