Ironclad Data Source

The Ironclad connector enables you to ingest contract, workflow, record, user, and approval data from your Ironclad CLM platform into Nexla. Follow the instructions below to create a new data flow that ingests data from an Ironclad source in Nexla.

Ironclad

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the Ironclad connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Ironclad instance, and click Next; or, create a new Ironclad credential for use in this flow.

3. In Nexla, Ironclad data sources can be created using pre-built endpoint templates, which expedite source setup for common Ironclad API endpoints. Each template is designed specifically for the corresponding Ironclad endpoint, making source configuration easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   Ironclad sources can also be configured manually, allowing you to ingest data from Ironclad endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Ironclad endpoints. Each template is designed specifically for the corresponding Ironclad API endpoint, making data source setup easy and efficient.

Endpoint Settings

• Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List All Workflows

Retrieves a paginated list of all workflows in your Ironclad instance, with optional filtering by status, template, last-updated timestamp, and custom filter criteria. Use this endpoint to pull workflow data for reporting, auditing, or downstream processing.

• This endpoint returns a paginated list of workflow objects. Nexla automatically iterates through all pages to collect the complete dataset.
• Optionally, enter a workflow status value in the Status field to filter results. Accepted values are active, paused, completed, and cancelled. Leave blank to retrieve workflows in all statuses.
• Optionally, enter a workflow template name or ID in the Template field to limit results to workflows launched from that template.
• Optionally, enter an ISO 8601 timestamp in the Last Updated field (e.g., 2024-01-01T00:00:00Z) to retrieve only workflows updated after that point in time.
• Optionally, enter a custom filter expression in the Filter field to apply additional criteria. Refer to the Ironclad API reference for supported filter syntax.
• Optionally, set Hydrate Entities to true to include full entity details (such as user objects) within the response, rather than returning only entity IDs.

Workflows are the core unit of Ironclad. Each workflow represents a business process and its associated contract — from initiation through review, approval, signing, and completion. For additional detail on workflow fields and filtering, see the List All Workflows reference in the Ironclad Developer Hub.

Retrieve a Workflow

Retrieves the full details of a single Ironclad workflow by its unique ID. Use this endpoint when you need complete metadata for a specific workflow, such as its current status, attributes, participants, and associated documents.

• Enter the unique identifier of the workflow in the Workflow ID field. This value is required. Workflow IDs can be found in the Ironclad UI or via the List All Workflows endpoint.
• Optionally, set Hydrate Entities to true to expand entity references within the response (e.g., replace user IDs with full user objects).

This endpoint returns a single record — the full representation of the specified workflow. It is best suited for targeted lookups rather than bulk data retrieval.

Retrieve the Status of an Async Workflow Create Job

Checks the status of a previously initiated asynchronous workflow creation job. Use this endpoint to poll the result of a workflow created with the "Create a Workflow Asynchronously" destination endpoint.

• Enter the job identifier returned by the asynchronous workflow creation call in the Job ID field. This value is required.
• The response will indicate whether the job is still processing, has completed successfully, or has failed, along with any resulting workflow ID on success.

Async workflow creation is useful for scenarios where synchronous creation would exceed timeout limits, such as when launching workflows with large documents or complex launch forms. The Job ID is returned immediately from the async create call and should be stored for subsequent status polling.

List All Workflow Approvals

Retrieves all approvals (approval roles and their current statuses) for a specific workflow. Use this endpoint to monitor approval progress or audit approval decisions on a contract workflow.

• Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
• The response includes each approval role defined in the workflow, along with its current status (e.g., pending, approved, rejected) and the approver details.

Retrieve the Approval Requests on a Workflow

Returns a paginated list of individual approval requests associated with a workflow. Unlike the approvals endpoint (which returns roles), this endpoint provides the individual approval request records, including decision timestamps and optional actor details.

• Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
• Optionally, set Actor Details to true to include full information about the users who made each approval decision.

• Optionally, enter a value in the Request Type field to filter approval requests by type. Accepted values are:

  • role — returns approval requests assigned to roles
  • user — returns approval requests assigned to specific users

Retrieve Sign Step Status

Returns the signing status of a workflow that is currently in the Sign step. Use this endpoint to check which parties have signed, which are pending, and the overall signing progress for a specific contract workflow.

• Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
• The response includes signing status information for all configured signers, including their signing state and any relevant timestamps.

List All Workflow Signers

Retrieves all signers configured for a specific workflow. Use this endpoint to see who is required to sign a contract and their current signing state.

• Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
• The response includes each signer's identity information, role, and whether they have completed signing.

List All Workflow Participants

Retrieves a paginated list of all participants in a specific workflow, with optional filtering by email address. Participants include all users who have been assigned a role in the workflow, such as reviewers, approvers, and signers.

• Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
• Optionally, enter an email address in the Email Filter field to return only participants matching that address.

List All Comments on a Workflow

Retrieves all comments from a workflow's activity feed, with pagination. Use this endpoint to extract collaboration history, reviewer notes, or audit trail information associated with a specific workflow.

• Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
• The response returns comment objects including the comment text, the author, and the timestamp at which each comment was posted.

Retrieve Documents from a Workflow

Returns all documents associated with a specific workflow, including contract documents and any supporting attachments. Use this endpoint to retrieve document metadata for workflows in any stage.

• Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
• The response includes document metadata such as document ID, name, and type. Direct file download is handled separately via Ironclad's document download APIs.

List All Records

Retrieves a paginated, filterable list of all contract records stored in the Ironclad Repository. Records represent completed contracts and their associated metadata. Use this endpoint for bulk export, reporting, or synchronization with external systems such as vendor management platforms or data warehouses.

• Optionally, enter a filter expression in the Filter Expression field to narrow the records returned. Refer to the Ironclad Records API documentation for supported filter syntax.

• Optionally, enter one or more record type values in the Record Types field to filter by record type (e.g., vendor agreements, NDAs, SOWs).
• Optionally, enter an ISO 8601 timestamp in the Last Updated field to retrieve only records updated after that point in time. This is useful for incremental data extraction.

• Optionally, configure sorting using the following fields:

  • Sort Field: Enter the field name by which results should be sorted.
  • Sort Direction: Select ASC for ascending order or DESC for descending order.
• Optionally, set Hydrate Entities to true to expand entity references (such as counterparty objects) within the response.
• Optionally, set Address As Object to true to return address-type fields as structured objects (with street, city, state, and country sub-fields) rather than as plain strings.

The Ironclad Repository stores metadata and documents for all completed contracts. This endpoint is commonly used to synchronize contract data with vendor management systems, ERP platforms, or analytics tools. For more information, refer to the Ironclad Records documentation.

Retrieve a Record

Fetches the complete metadata for a single contract record by its unique ID. Use this endpoint for targeted lookups of specific contracts in the Ironclad Repository.

• Enter the unique identifier of the record in the Record ID field. This value is required. Record IDs can be found via the List All Records endpoint or in the Ironclad UI.
• Optionally, set Hydrate Entities to true to expand entity references within the response.
• Optionally, set Address As Object to true to return address fields as structured objects rather than plain strings.

Retrieve Records Schema

Returns the schema for contract records in your Ironclad instance, including available record types and their properties. Use this endpoint to discover the structure of your Records data before building ingestion flows or data mappings.

• No parameters are required for this endpoint. It returns the complete records schema, including all available record types and the fields defined for each type in your Ironclad configuration.
• The schema is specific to your Ironclad instance and reflects any custom fields or record types your legal operations team has configured.

This endpoint is particularly useful when setting up data mapping or schema discovery in Nexla. Running it first helps you understand the available fields before configuring List All Records or Retrieve a Record data flows.

List All Workflow Schemas

Retrieves all workflow schemas from your Ironclad instance. A workflow schema describes the launch form fields for a specific workflow template, including field names, types, and validation rules. Use this endpoint to discover the structure of available workflow templates before building workflow creation flows.

• No parameters are required. The endpoint returns a list of all available workflow schemas, one per active workflow template in your instance.

Retrieve a Workflow Schema

Returns the launch form schema for a specific workflow template. Use this endpoint to understand the required and optional fields for launching a particular type of workflow in Ironclad.

• Enter the unique identifier of the workflow template in the Workflow Schema ID field. This value is required. Template IDs can be found using the List All Workflow Schemas endpoint.
• The response includes the full schema definition for the template's launch form, including all field names, data types, and required/optional status.

Reviewing the workflow schema before building a "Create a Workflow" destination flow ensures that the data you are sending matches Ironclad's expected launch form structure. For guidance, see the Launch a Workflow guide in the Ironclad Developer Hub.

List All Users

Retrieves a paginated list of all users in your Ironclad instance via the SCIM 2.0 protocol. Use this endpoint to synchronize Ironclad user data with external identity management or HR systems.

• Optionally, enter a SCIM filter expression in the Filter field to narrow the results (e.g., userName eq "john.doe@example.com").
• Optionally, enter a comma-separated list of user attributes in the Excluded Attributes field to omit those attributes from the response, reducing payload size.

Ironclad's user management API follows the SCIM 2.0 standard. For the complete SCIM filter syntax and available user attributes, refer to the Ironclad Users API documentation.

List All Groups

Retrieves a paginated list of all groups in your Ironclad instance via the SCIM 2.0 protocol. Use this endpoint to synchronize Ironclad group membership data with external directory services or provisioning systems.

• Optionally, enter a SCIM filter expression in the Filter field to narrow the results (e.g., displayName eq "Legal Team").
• Optionally, enter a comma-separated list of group attributes in the Excluded Attributes field to omit those attributes from the response.

Ironclad's group management API follows the SCIM 2.0 standard. For additional details on filter syntax and group attributes, see the Ironclad Groups API documentation.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Ironclad data sources can be manually configured to ingest data from any valid Ironclad API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Ironclad sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the Ironclad API from the Method pulldown menu. The most common methods are:

   • GET: For retrieving data from the API
   • POST: For sending data to the API or triggering actions
   • PUT: For updating existing data
   • PATCH: For partial updates to existing data
   • DELETE: For removing data

API Endpoint URL

3. Enter the URL of the Ironclad API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

Ironclad's public API base URL is your instance URL followed by /public/api/v1/. For example, a North America instance would use https://na1.ironcladapp.com/public/api/v1/. User management endpoints use the SCIM base path: https://na1.ironcladapp.com/scim/v2/. Refer to the Ironclad Developer Hub for the full API reference.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are particularly useful with Ironclad's filtering parameters. For example, you can use {now-1} in a lastUpdated query parameter to incrementally fetch only records or workflows that have changed since the previous run.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime
   • {now-1} – The datetime one time unit before the current datetime
   • {now+1} – The datetime one time unit after the current datetime
   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful for Ironclad endpoints that require a specific Workflow ID or Record ID in the URL path. For example, you can iterate over a list of workflow IDs from another Nexla source to fetch detailed data for each workflow in turn.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data returned by an Ironclad API endpoint is needed, you can designate the part of the response that should be included in the Nexsets produced from this source by specifying the path to the relevant data. This is particularly useful because Ironclad API responses typically wrap list results inside a top-level object.

For example, the List All Workflows endpoint returns a JSON object with a list property containing the array of workflow records. By entering the path $.list[*], you can configure Nexla to treat each element of that array as an individual record.

Path to Data is essential for most Ironclad list endpoints, where the records of interest are nested under a list key. For single-resource endpoints (such as Retrieve a Workflow), the path is typically $ to return the entire response object as a single record.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.list[*] to access a list array, or $.Resources[*] for SCIM endpoints).
  Path to Data Examples for Ironclad:

  • List endpoints (workflows, records, participants, comments): $.list[*]
  • SCIM list endpoints (users, groups): $.Resources[*]
  • Single-record endpoints (retrieve workflow, retrieve record): $

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record.

For example, Ironclad's list endpoints typically return a total count and pagination metadata alongside the list array. If you have set the path to data to $.list[*], you can set the metadata path to $ to attach the top-level response object (including total and pagination fields) to each record.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

  You do not need to include any headers already present in the credentials. Ironclad's OAuth 2.0 Bearer token Authorization header is automatically included by Nexla based on your credential configuration.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Ironclad data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.