Skip to main content
Ironclad
Ironclad
64 actions · 12 events · 2 auth methods
Beta

​
Authentication

OAuth 2.0

OAuth 2.0 Authorization Code grant — the connection acts on behalf of the authorizing Ironclad user, honoring that user’…Guides: Connector Profile, Link Account

OAuth 2.0 (Client Credentials)

OAuth 2.0 Client Credentials grant — server-to-server (app-only) access with no user sign-in. Most write actions require…Guides: Connector Profile, Link Account
Actions
|
64 actions
Action
Description
Required scopes
Create A Workflow Synchronously
Create a Workflow Synchronously
List All Workflows
List All Workflows
Retrieve A Workflow
Retrieve a Workflow
List All Workflow Approvals
List All Workflow Approvals
Update Approval Status On A Workflow
Update Approval Status on a Workflow
Retrieve The Turn History On A Workflow
Retrieve the Turn History on a Workflow
Retrieve Sign Step Status
Retrieve Sign Step Status
Send Signature Request
Send Signature Request
Cancel Signature Request
Cancel Signature Request
List All Workflow Signers
List All Workflow Signers
List All Workflow Participants
List All Workflow Participants
Cancel A Workflow
Cancel a Workflow
Pause A Workflow
Pause a Workflow
Resume A Workflow
Resume a Workflow
Create A Comment On A Workflow
Create a Comment on a Workflow
List All Comments On A Workflow
List all Comments on a Workflow
List A Comment From A Specified Workflow
List a Comment from a Specified Workflow
Update Workflow Metadata
Update Workflow Metadata
Retrieve Documents From A Workflow
Retrieve Documents from a Workflow
Retrieve A Workflow Document
Retrieve a Workflow Document
List All Workflow Schemas
List All Workflow Schemas
Retrieve A Workflow Schema
Retrieve a Workflow Schema
List All Records
List All Records
Create A Record
Create a Record
Retrieve A Record
Retrieve a Record
Replace A Record
Replace a Record
Delete A Record
Delete a Record
Update Record Metadata
Update Record Metadata
Retrieve Records Schema
Retrieve Records Schema
Create An Attachment On A Record
Create an Attachment on a Record
Retrieve An Attachment On A Record
Retrieve an Attachment on a Record
Delete An Attachment On A Record
Delete an Attachment on a Record
Run An Action On A Record
Run an Action on a Record
Create A Webhook
Create a Webhook
List All Webhooks
List All Webhooks
Retrieve A Webhook
Retrieve a Webhook
Update A Webhook
Update a Webhook
Delete A Webhook
Delete a Webhook
Retrieve Webhook Verification Key
Retrieve Webhook Verification Key
Get All Entity Relationship Types
Get All Entity Relationship Types
List All Entities
List All Entities
Create An Entity
Create an Entity
Retrieve An Entity
Retrieve an Entity
Update An Entity
Update an Entity
Delete An Entity
Delete an Entity
List All Obligations
List All Obligations
Create An Obligation
Create an Obligation
Retrieve An Obligation
Retrieve an Obligation
Update An Obligation
Update an Obligation
Submit A Request To Generate A New Data Export
Submit a request to generate a new data export
Check Data Export Job Status
Check Data Export Job Status
Download Data Export File
Download Data Export File
Workflow Launched
Triggered when an Ironclad workflow is launched (e.g. via the launch_a_new_workflow action). Retrieve the workflow with…
Workflow Completed
Triggered when an Ironclad workflow reaches completion. payload.recordIDs lists the records created from the workflow; r…
Workflow Cancelled
Triggered when an Ironclad workflow is cancelled (e.g. via the cancel_a_workflow action). Retrieve the workflow with get…
Workflow Paused
Triggered when an Ironclad workflow is paused (e.g. via the pause_a_workflow action). Retrieve the workflow with get_wor…
Workflow Resumed
Triggered when an Ironclad workflow is resumed (e.g. via the resume_a_workflow action). Retrieve the workflow with get_w…
Workflow Approval Status Changed
Triggered when the approval status of an Ironclad workflow changes (e.g. via the update_workflow_approval action). Retri…
Workflow Attribute Updated
Triggered when workflow attributes are modified (e.g. via the update_workflow_metadata action). payload.changedAttribute…
Workflow Comment Added
Triggered when a comment is added to an Ironclad workflow (e.g. via the create_comment_on_a_workflow action). payload.co…
Signature Packet Sent
Triggered when a signature packet is sent out for signature (e.g. via the send_signature_request action). Retrieve the w…
Signature Packet Cancelled
Triggered when a signature request is cancelled (e.g. via the cancel_signature_request action). payload.cause holds the…
Signature Packet Fully Signed
Triggered when all signers have signed the signature packet on an Ironclad workflow. Retrieve the workflow with get_work…
Contract Status Changed
Triggered when the contract status of an Ironclad repository record changes (e.g. via the run_an_action_on_a_record or r…
Events
12 events
Event
Description
Workflow Launched
Triggered when an Ironclad workflow is launched (e.g. via the launch_a_new_workflow action). Retrieve the workflow with…
Workflow Completed
Triggered when an Ironclad workflow reaches completion. payload.recordIDs lists the records created from the workflow; r…
Workflow Cancelled
Triggered when an Ironclad workflow is cancelled (e.g. via the cancel_a_workflow action). Retrieve the workflow with get…
Workflow Paused
Triggered when an Ironclad workflow is paused (e.g. via the pause_a_workflow action). Retrieve the workflow with get_wor…
Workflow Resumed
Triggered when an Ironclad workflow is resumed (e.g. via the resume_a_workflow action). Retrieve the workflow with get_w…
Workflow Approval Status Changed
Triggered when the approval status of an Ironclad workflow changes (e.g. via the update_workflow_approval action). Retri…
Workflow Attribute Updated
Triggered when workflow attributes are modified (e.g. via the update_workflow_metadata action). payload.changedAttribute…
Workflow Comment Added
Triggered when a comment is added to an Ironclad workflow (e.g. via the create_comment_on_a_workflow action). payload.co…
Signature Packet Sent
Triggered when a signature packet is sent out for signature (e.g. via the send_signature_request action). Retrieve the w…
Signature Packet Cancelled
Triggered when a signature request is cancelled (e.g. via the cancel_signature_request action). payload.cause holds the…
Signature Packet Fully Signed
Triggered when all signers have signed the signature packet on an Ironclad workflow. Retrieve the workflow with get_work…
Contract Status Changed
Triggered when the contract status of an Ironclad repository record changes (e.g. via the run_an_action_on_a_record or r…

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/ironclad/filled/png

Connector Profile

Ironclad - OAuth 2.0
https://stackone-logos.com/api/ironclad/filled/png

Connector Profile

Ironclad - OAuth 2.0 (Client Credentials)
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/ironclad/filled/png

Link Account

Ironclad - OAuth 2.0
https://stackone-logos.com/api/ironclad/filled/png

Link Account

Ironclad - OAuth 2.0 (Client Credentials)
4

Use Actions

Invoke actions using one of the methods below: