> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ironclad

> How to set up the Ironclad connector, plus the actions and events that are available.

![Ironclad](https://stackone-logos.com/api/ironclad/filled/svg)

Betav2.0.0[See changelog](https://docs.stackone.com/connectors/ironclad/changelog.md)

[64 actions](#actions) · [12 events](#events) · 2 auth methods

Contract Lifecycle Management

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/ironclad/guides/connector-profile/oauth-2-0.md)
>
> OAuth 2.0 Authorization Code grant — the connection acts on behalf of the authorizing Ironclad user, honoring that user'...

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/ironclad/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> OAuth 2.0 Client Credentials grant — server-to-server (app-only) access with no user sign-in. Most write actions require...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/ironclad/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/ironclad/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

public.entities.createEntities

public.entities.deleteEntities

public.entities.readEntities

public.entities.readRelationshipTypes

public.entities.updateEntities

public.export.createReports

public.export.readReports

public.obligations.createObligations

public.obligations.readObligations

public.obligations.updateObligations

public.records.applyContractAction

public.records.createAttachments

public.records.createRecords

public.records.deleteAttachments

public.records.deleteRecords

public.records.readAttachments

public.records.readRecords

public.records.readSchemas

public.records.updateRecords

public.webhooks.createWebhooks

public.webhooks.deleteWebhooks

public.webhooks.readWebhooks

public.webhooks.updateWebhooks

public.workflows.cancel

public.workflows.cancelSignatureRequests

public.workflows.createComments

public.workflows.createWorkflows

public.workflows.pauseAndResume

public.workflows.readApprovals

public.workflows.readComments

public.workflows.readDocuments

public.workflows.readParticipants

public.workflows.readSchemas

public.workflows.readSignStatus

public.workflows.readSignatures

public.workflows.readTurnHistory

public.workflows.readWorkflows

public.workflows.sendSignatureRequests

public.workflows.updateApprovals

public.workflows.updateWorkflows

No scopes found

64 actions

ActionDescriptionRequired scopes

Create A Workflow Synchronously`ironclad_launch_a_new_workflow`

Create a Workflow Synchronously

`public.workflows.createWorkflows`

List All Workflows`ironclad_list_workflows`

List All Workflows

`public.workflows.readWorkflows`

Retrieve A Workflow`ironclad_get_workflow`

Retrieve a Workflow

`public.workflows.readWorkflows`

List All Workflow Approvals`ironclad_list_workflow_approvals`

List All Workflow Approvals

`public.workflows.readApprovals`

Update Approval Status On A Workflow`ironclad_update_workflow_approval`

Update Approval Status on a Workflow

`public.workflows.updateApprovals`

Retrieve The Turn History On A Workflow`ironclad_turn_history`

Retrieve the Turn History on a Workflow

`public.workflows.readTurnHistory`

Retrieve Sign Step Status`ironclad_get_sign_status`

Retrieve Sign Step Status

`public.workflows.readSignStatus`

Send Signature Request`ironclad_send_signature_request`

Send Signature Request

`public.workflows.sendSignatureRequests`

Cancel Signature Request`ironclad_cancel_signature_request`

Cancel Signature Request

`public.workflows.cancelSignatureRequests`

List All Workflow Signers`ironclad_list_workflow_signers`

List All Workflow Signers

`public.workflows.readSignatures`

List All Workflow Participants`ironclad_list_workflow_participants`

List All Workflow Participants

`public.workflows.readParticipants`

Cancel A Workflow`ironclad_cancel_a_workflow`

Cancel a Workflow

`public.workflows.cancel`

Pause A Workflow`ironclad_pause_a_workflow`

Pause a Workflow

`public.workflows.pauseAndResume`

Resume A Workflow`ironclad_resume_a_workflow`

Resume a Workflow

`public.workflows.pauseAndResume`

Create A Comment On A Workflow`ironclad_create_comment_on_a_workflow`

Create a Comment on a Workflow

`public.workflows.createComments`

List All Comments On A Workflow`ironclad_list_comments_in_a_workflow`

List all Comments on a Workflow

`public.workflows.readComments`

List A Comment From A Specified Workflow`ironclad_get_comment_from_a_workflow`

List a Comment from a Specified Workflow

`public.workflows.readComments`

Update Workflow Metadata`ironclad_update_workflow_metadata`

Update Workflow Metadata

`public.workflows.updateWorkflows`

Retrieve Documents From A Workflow`ironclad_get_workflow_documents`

Retrieve Documents from a Workflow

`public.workflows.readDocuments`

Retrieve A Workflow Document`ironclad_get_workflow_document`

Retrieve a Workflow Document

`public.workflows.readDocuments`

List All Workflow Schemas`ironclad_list_workflow_schemas`

List All Workflow Schemas

`public.workflows.readSchemas`

Retrieve A Workflow Schema`ironclad_get_workflow_schema`

Retrieve a Workflow Schema

`public.workflows.readSchemas`

List All Records`ironclad_list_records`

List All Records

`public.records.readRecords`

Create A Record`ironclad_create_record`

Create a Record

`public.records.createRecords`

Retrieve A Record`ironclad_get_record`

Retrieve a Record

`public.records.readRecords`

Replace A Record`ironclad_replace_record`

Replace a Record

`public.records.updateRecords`

Delete A Record`ironclad_delete_record`

Delete a Record

`public.records.deleteRecords`

Update Record Metadata`ironclad_update_record_metadata`

Update Record Metadata

`public.records.updateRecords`

Retrieve Records Schema`ironclad_list_records_metadata`

Retrieve Records Schema

`public.records.readSchemas`

Create An Attachment On A Record`ironclad_create_attachment_on_a_record`

Create an Attachment on a Record

`public.records.createAttachments`

Retrieve An Attachment On A Record`ironclad_get_attachment_on_a_record`

Retrieve an Attachment on a Record

`public.records.readAttachments`

Delete An Attachment On A Record`ironclad_delete_attachment_on_a_record`

Delete an Attachment on a Record

`public.records.deleteAttachments`

Run An Action On A Record`ironclad_run_an_action_on_a_record`

Run an Action on a Record

`public.records.applyContractAction`

Create A Webhook`ironclad_create_webhook`

Create a Webhook

`public.webhooks.createWebhooks`

List All Webhooks`ironclad_list_webhooks`

List All Webhooks

`public.webhooks.readWebhooks`

Retrieve A Webhook`ironclad_get_webhook`

Retrieve a Webhook

`public.webhooks.readWebhooks`

Update A Webhook`ironclad_update_a_webhook`

Update a Webhook

`public.webhooks.updateWebhooks`

Delete A Webhook`ironclad_delete_webhook`

Delete a Webhook

`public.webhooks.deleteWebhooks`

Retrieve Webhook Verification Key`ironclad_get_webhook_verification_key`

Retrieve Webhook Verification Key

Get All Entity Relationship Types`ironclad_list_entity_relationship_types`

Get All Entity Relationship Types

`public.entities.readRelationshipTypes`

List All Entities`ironclad_list_entities`

List All Entities

`public.entities.readEntities`

Create An Entity`ironclad_create_entity`

Create an Entity

`public.entities.createEntities`

Retrieve An Entity`ironclad_get_entity`

Retrieve an Entity

`public.entities.readEntities`

Update An Entity`ironclad_update_an_entity`

Update an Entity

`public.entities.updateEntities`

Delete An Entity`ironclad_delete_entity`

Delete an Entity

`public.entities.deleteEntities`

List All Obligations`ironclad_list_obligations`

List All Obligations

`public.obligations.readObligations`

Create An Obligation`ironclad_create_obligation`

Create an Obligation

`public.obligations.createObligations`

Retrieve An Obligation`ironclad_get_obligation`

Retrieve an Obligation

`public.obligations.readObligations`

Update An Obligation`ironclad_update_an_obligation`

Update an Obligation

`public.obligations.updateObligations`

Submit A Request To Generate A New Data Export`ironclad_export`

Submit a request to generate a new data export

`public.export.createReports`

Check Data Export Job Status`ironclad_export_job`

Check Data Export Job Status

`public.export.readReports`

Download Data Export File`ironclad_export_job_download`

Download Data Export File

`public.export.readReports`

Workflow Launched`ironclad_webhook_workflow_launched`

Triggered when an Ironclad workflow is launched (e.g. via the launch\_a\_new\_workflow action). Retrieve the workflow with...

`public.webhooks.createWebhooks`

Workflow Completed`ironclad_webhook_workflow_completed`

Triggered when an Ironclad workflow reaches completion. payload.recordIDs lists the records created from the workflow; r...

`public.webhooks.createWebhooks`

Workflow Cancelled`ironclad_webhook_workflow_cancelled`

Triggered when an Ironclad workflow is cancelled (e.g. via the cancel\_a\_workflow action). Retrieve the workflow with get...

`public.webhooks.createWebhooks`

Workflow Paused`ironclad_webhook_workflow_paused`

Triggered when an Ironclad workflow is paused (e.g. via the pause\_a\_workflow action). Retrieve the workflow with get\_wor...

`public.webhooks.createWebhooks`

Workflow Resumed`ironclad_webhook_workflow_resumed`

Triggered when an Ironclad workflow is resumed (e.g. via the resume\_a\_workflow action). Retrieve the workflow with get\_w\...

`public.webhooks.createWebhooks`

Workflow Approval Status Changed`ironclad_webhook_workflow_approval_status_changed`

Triggered when the approval status of an Ironclad workflow changes (e.g. via the update\_workflow\_approval action). Retri...

`public.webhooks.createWebhooks`

Workflow Attribute Updated`ironclad_webhook_workflow_attribute_updated`

Triggered when workflow attributes are modified (e.g. via the update\_workflow\_metadata action). payload.changedAttribute...

`public.webhooks.createWebhooks`

Workflow Comment Added`ironclad_webhook_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...

`public.webhooks.createWebhooks`

Signature Packet Sent`ironclad_webhook_workflow_signature_packet_sent`

Triggered when a signature packet is sent out for signature (e.g. via the send\_signature\_request action). Retrieve the w\...

`public.webhooks.createWebhooks`

Signature Packet Cancelled`ironclad_webhook_workflow_signature_packet_cancelled`

Triggered when a signature request is cancelled (e.g. via the cancel\_signature\_request action). payload.cause holds the...

`public.webhooks.createWebhooks`

Signature Packet Fully Signed`ironclad_webhook_workflow_signature_packet_fully_signed`

Triggered when all signers have signed the signature packet on an Ironclad workflow. Retrieve the workflow with get\_work...

`public.webhooks.createWebhooks`

Contract Status Changed`ironclad_webhook_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...

`public.webhooks.createWebhooks`

## Events

Tags

Select all
|
Clear

Records

Webhooks

Workflows

No tags found

12 events

EventDescriptionTags

Workflow Launched`ironclad_webhook_workflow_launched`

Triggered when an Ironclad workflow is launched (e.g. via the launch\_a\_new\_workflow action). Retrieve the workflow with...

WorkflowsWebhooks

Workflow Completed`ironclad_webhook_workflow_completed`

Triggered when an Ironclad workflow reaches completion. payload.recordIDs lists the records created from the workflow; r...

WorkflowsWebhooks

Workflow Cancelled`ironclad_webhook_workflow_cancelled`

Triggered when an Ironclad workflow is cancelled (e.g. via the cancel\_a\_workflow action). Retrieve the workflow with get...

WorkflowsWebhooks

Workflow Paused`ironclad_webhook_workflow_paused`

Triggered when an Ironclad workflow is paused (e.g. via the pause\_a\_workflow action). Retrieve the workflow with get\_wor...

WorkflowsWebhooks

Workflow Resumed`ironclad_webhook_workflow_resumed`

Triggered when an Ironclad workflow is resumed (e.g. via the resume\_a\_workflow action). Retrieve the workflow with get\_w\...

WorkflowsWebhooks

Workflow Approval Status Changed`ironclad_webhook_workflow_approval_status_changed`

Triggered when the approval status of an Ironclad workflow changes (e.g. via the update\_workflow\_approval action). Retri...

WorkflowsWebhooks

Workflow Attribute Updated`ironclad_webhook_workflow_attribute_updated`

Triggered when workflow attributes are modified (e.g. via the update\_workflow\_metadata action). payload.changedAttribute...

WorkflowsWebhooks

Workflow Comment Added`ironclad_webhook_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...

WorkflowsWebhooks

Signature Packet Sent`ironclad_webhook_workflow_signature_packet_sent`

Triggered when a signature packet is sent out for signature (e.g. via the send\_signature\_request action). Retrieve the w\...

WorkflowsWebhooks

Signature Packet Cancelled`ironclad_webhook_workflow_signature_packet_cancelled`

Triggered when a signature request is cancelled (e.g. via the cancel\_signature\_request action). payload.cause holds the...

WorkflowsWebhooks

Signature Packet Fully Signed`ironclad_webhook_workflow_signature_packet_fully_signed`

Triggered when all signers have signed the signature packet on an Ironclad workflow. Retrieve the workflow with get\_work...

WorkflowsWebhooks

Contract Status Changed`ironclad_webhook_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...

RecordsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.