Connect your own Ironclad CLM company -- launch and manage contract workflows, browse the signed-agreement Records repository, manage counterparty Entities and post-signature Obligations, and wire up webhooks for real-time contract lifecycle events.
connect_ironcladwriteConnect your own Ironclad CLM company using an OAuth Client (Client ID/Secret) registered in Ironclad's Company Settings > API, after checking it actually works.
disconnect_ironcladwriteDisconnect one Ironclad company. Nothing in Ironclad itself is changed; only the saved OAuth Client credentials here are deleted.
list_connectionsreadList the connected Ironclad companies.
list_all_workflowsreadList active/in-progress Ironclad workflows (contracts currently moving through approval, not yet completed records). Paginated.
get_workflowreadRead one Ironclad workflow in full: current step, attribute values, participants, and approval state.
launch_workflowwriteLaunch a new Ironclad workflow (contract request) synchronously from a template. Blocks until created -- use launch_workflow_async if attaching large files.
launch_workflow_asyncwriteLaunch a new Ironclad workflow asynchronously (non-blocking) -- recommended when the launch also includes file attachments. Returns immediately with a launch acknowledgement; poll get_workflow with the returned id to see it settle.
bulk_launch_workflowwriteLaunch several workflows from the same template in one call, e.g. one NDA per new counterparty. Pass launches_json as a JSON array of {name, attributes} objects.
cancel_workflowwriteCancel an active Ironclad workflow before it completes.
revert_workflow_to_reviewwriteSend an active workflow back to its Review step -- e.g. after a signer rejects, or new redlines require another look.
list_workflow_schemasreadList all workflow designs (templates) configured in this Ironclad company -- their template ids, needed to launch a workflow.
get_workflow_schemareadRead one workflow design (template) in full -- its launch-form attribute ids and types, needed before calling launch_workflow.
update_workflow_attributeswriteUpdate one or more attribute values on an active workflow, e.g. correcting a counterparty name mid-review.
get_workflow_attachmentreadRead one file attachment's metadata/download info on an active workflow.
add_workflow_attachmentwriteAttach a file (fetched from a publicly reachable URL) to an active workflow.
create_workflow_commentwriteAdd a comment to an active workflow, visible to its participants inside Ironclad.
send_signature_requestwriteTrigger Ironclad's e-signature flow for a workflow currently ready for signature, naming who should sign.
get_signature_statusreadRead the current e-signature status of a workflow -- who has signed, who is pending.
update_approvalwriteApprove or reject a pending approval step on a workflow, acting as the connection's configured user.
list_recordsreadList records (completed/signed agreements) in the connected Ironclad company, with optional filtering by type, last-updated timestamp, and one property value.
get_recordreadRead one record (completed/signed agreement) in full, including its properties and attachment list.
get_records_schemareadRead the Records schema: every record type and its configured properties/attributes, needed before create_record or update_record.
create_recordwriteCreate a new record directly (e.g. migrating a legacy signed agreement into Ironclad without running it through a workflow first).
update_recordwriteUpdate selected property values on an existing record. Only the properties you pass change.
delete_recorddestructivePermanently delete a record. Cannot be undone through the API -- use with care.
get_record_attachmentreadRead one record attachment's metadata and download link.
add_record_attachmentwriteAttach a file to an existing record by giving Ironclad a publicly reachable URL to fetch it from.
delete_record_attachmentdestructivePermanently remove an attachment from a record. Cannot be undone.
apply_contract_actionwriteApply a post-signature contract action to a record -- e.g. renew, terminate, or amend -- using the action types configured for that record's type.
smart_import_recordwriteCreate a record from an already-signed document by URL, using Ironclad's own AI to extract its metadata automatically -- ideal for bulk-migrating a legacy contract archive.
list_entitiesreadList counterparty/contact entities (companies and individuals) registered in the connected Ironclad company.
get_entityreadRead one counterparty/contact entity in full.
create_entitywriteCreate a new counterparty/contact entity (a company or individual your organization contracts with).
update_entitywriteUpdate selected property values of an existing entity. Only the given properties change.
delete_entitydestructivePermanently delete a counterparty/contact entity. Cannot be undone -- records/workflows referencing it will lose that link.
list_relationship_typesreadList the relationship types available for linking entities to each other (e.g. 'Parent Company', 'Subsidiary').
list_obligationsreadList post-signature obligations (renewal reminders, SLA deliverables, compliance deadlines), optionally filtered to one record.
get_obligationreadRead one obligation in full.
create_obligationwriteCreate a new obligation linked to an existing record -- a deadline or deliverable that outlives the signature process.
update_obligationwriteUpdate selected property values of an existing obligation. Only the given properties change.
delete_obligationdestructivePermanently delete an obligation. Cannot be undone.
list_webhooksreadList webhook subscriptions configured on the connected Ironclad company.
create_webhookwriteSubscribe to Ironclad workflow/record/obligation lifecycle events -- Ironclad will POST event payloads to your target URL as they happen.
update_webhookwriteUpdate an existing webhook's target URL and/or subscribed events. Only the given fields change.
delete_webhookdestructivePermanently remove a webhook subscription. Cannot be undone.
create_reportwriteStart a data export (report) of records or workflows for offline analysis. Requires the Reports/Exports feature to be enabled on your Ironclad plan -- a permission error here likely means it isn't.
get_reportreadCheck the status of a data export and get its download URL once ready.
audit_contract_healthreadBuild one aggregated health report across the connected Ironclad company: active vs stalled workflows, recently completed workflows, and obligations due in the next 30 days -- one call instead of manually cross-referencing several reads.
find_expiring_contractsreadValue-add report: scan records and flag every one whose agreement/expiration date falls within a given window from now -- absorbs the client-side date-window math Ironclad's own list_records filter doesn't do.
bulk_tag_recordswriteApply the same property values to several existing records in one call -- e.g. tagging every contract from an acquired subsidiary with a new business-unit code. Ironclad's own API has no native bulk-update endpoint for records, so this loops update_record and reports how many succeeded.
Install Ironclad and let Webbee use it across your workflow.
Open in panel