Skip to main content

Ironclad

Manage Ironclad CLM workflows, records, comments, approvals and webhooks via the Public API.

Categories: Legal, CRM

What you can ask​

  • List workflows waiting on legal review and how long each has been open
  • Find executed contracts with Acme Corp that renew in the next 90 days
  • Launch an NDA workflow for counterparty Globex Inc

Set up​

Ironclad needs an OAuth application from your organization before anyone can connect. An organization admin completes these steps once.

  1. Go to Organization > Connectors and find Ironclad. Click Enable, and choose which tools to allow.
  2. Create an OAuth application in the Ironclad developer portal.
  3. Add the Redirect URI shown in the connector settings to the application.
  4. Copy the application's Client ID and Client Secret into the connector, then save it.
  5. Each member connects their own account the first time they use it.

⚠️ Warning: Do not enter your Devs.ai or Ironclad login email or password in the OAuth application fields.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

OAuth scopes used by these tools (18)

Grant the scopes for the tools you plan to allow.

  • public.records.createRecords
  • public.records.deleteRecords
  • public.records.readRecords
  • public.records.readSchemas
  • public.records.updateRecords
  • public.webhooks.createWebhooks
  • public.webhooks.deleteWebhooks
  • public.webhooks.readWebhooks
  • public.webhooks.updateWebhooks
  • public.workflows.createComments
  • public.workflows.createWorkflows
  • public.workflows.readApprovals
  • public.workflows.readComments
  • public.workflows.readParticipants
  • public.workflows.readSchemas
  • public.workflows.readTurnHistory
  • public.workflows.readWorkflows
  • public.workflows.updateWorkflows

Tools​

Ironclad offers 26 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (16)​

View and search information without changing it.

ToolWhat it does
get_recordRetrieve one repository record by ID — type, properties, attachments, links, contract status.
get_records_metadataGet the record-type catalog and property schema for the Ironclad repository — the valid type values and properties keys that create_record and update_record require.
get_webhookRetrieve one webhook subscription by ID.
get_webhook_verification_keyGet Ironclad's public key (PEM) for verifying signatures on inbound webhook payloads at your target URL.
get_workflowRetrieve one workflow by ID — step, status, attributes, creator, record links.
get_workflow_approvalsGet a workflow's approval state — approval groups, reviewer statuses and role assignments.
get_workflow_commentRetrieve one comment on a workflow by ID.
get_workflow_schemaRetrieve one workflow template by ID, including its full attribute schema.
list_recordsList Ironclad repository records, filterable by record type, free-text search, last-updated time and formula filter, with sort controls.
list_webhooksList Ironclad webhook subscriptions — event lists, target URLs and enabled/disabled status.
list_workflow_commentsList comments on a workflow's activity feed (newest activity, author, mentions).
list_workflow_participantsList the users participating on a workflow (userId + email).
list_workflow_schemasList Ironclad workflow templates (launch forms).
list_workflow_turn_historyList a workflow's turn history — who held the pen (internal vs counterparty) and when.
list_workflowsList Ironclad workflows, filterable by status, template, free-text search, formula filter and last-updated time.
validate_credentialValidate the Ironclad access token by listing workflow schemas (the cheapest authenticated read; requires public.workflows.readSchemas).

Write (4)​

Create or send data.

ToolWhat it does
create_recordCreate a repository record (a contract file with metadata properties).
create_webhookSubscribe a target URL to Ironclad events, e.g. events=['workflow_launched'] or ['*'] for all (not recommended at high volume).
create_workflowLaunch a new Ironclad workflow from a template.
create_workflow_commentPost a comment on a workflow's activity feed. @-mention a user as <@john.doe@example.com>.

Delete or overwrite (6)​

Remove or replace existing data.

ToolWhat it does
delete_recordPermanently delete a repository record.
delete_webhookDelete a webhook subscription.
replace_recordReplace a record's writable fields wholesale (PUT semantics — the property map is replaced, not merged).
update_recordPatch a record — rename, retype, add/overwrite or remove properties (addProperties/removeProperties keyed by property ID from get_records_metadata).
update_webhookUpdate a webhook's events, target URL or enabled/disabled status.
update_workflow_attributesPatch attributes on an in-flight workflow (set/remove values by attribute ID — the path key on each update).
⌘J