Ironclad Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an Ironclad location.

Ironclad

Create an Ironclad Destination

1. Click the + icon on the Nexset that will be sent to the Ironclad destination, and select the Send to Destination option from the menu.

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

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

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

Configure Using a Template

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

• To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

  Create a Workflow Synchronously

  Launches a new Ironclad workflow and waits for the operation to complete before returning a response. Use this endpoint when you need immediate confirmation that a workflow was created and need the resulting workflow ID before proceeding.

  • The request body must be a valid Ironclad workflow launch payload in JSON format. The required fields depend on the workflow template's launch form schema. To review the expected fields for a specific template, use the Retrieve a Workflow Schema source endpoint first.

  • Each workflow payload must include the template ID and values for all required launch form fields defined by the template's schema. Optional fields can be omitted.
  • Optionally, configure the Use Default Values setting if your workflow template supports default field values and you wish to apply them when fields are not explicitly provided in the payload.

  Synchronous workflow creation is best suited for lower-volume flows where immediate confirmation is needed. For high-volume scenarios or workflows with large documents, consider using the "Create a Workflow Asynchronously" template instead. For complete guidance on constructing the launch payload, refer to the Launch a Workflow guide in the Ironclad Developer Hub.

  Create a Workflow Asynchronously

  Initiates a new Ironclad workflow creation job asynchronously and immediately returns a job ID. Use this endpoint for high-volume workflow creation flows or when the workflow launch may take longer than a synchronous request timeout allows.

  • The request body must be a valid Ironclad workflow launch payload in JSON format, identical in structure to the synchronous create endpoint. Required fields are determined by the target workflow template's launch form schema.

  • The endpoint returns a job ID immediately. Use the Retrieve the Status of an Async Workflow Create Job source endpoint with this job ID to poll for the completion status and retrieve the resulting workflow ID once the job finishes.

  Asynchronous workflow creation is recommended for bulk-creation scenarios or when integrating with systems that may generate workflows in large batches. Store the returned job ID in your data flow for subsequent status checks. Refer to the Ironclad Developer Hub for additional guidance.

  Update Approval on a Workflow

  Updates the approval status for a specific approver role on an Ironclad workflow. Use this endpoint to programmatically approve or reject a workflow approval step as part of an automated approval flow.

  • Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
  • Enter the unique identifier of the approver role to update in the Role ID field. This value is required. Role IDs can be retrieved from the List All Workflow Approvals source endpoint.
  • The request body (passed via the Nexset) should include the approval decision and any supporting information such as comments. Refer to the Ironclad Approvals API documentation for the expected request body format.

  Send Signature Request

  Sends a signature request for a workflow that is in the Sign step. Use this endpoint to programmatically initiate the signing process for a contract workflow.

  • Enter the unique identifier of the workflow in the Workflow ID field. This value is required. The workflow must already be in the Sign step for this action to succeed.
  • The request body should include any required signer configuration or override parameters as defined in the Ironclad Signatures API. Refer to the Ironclad Workflows API documentation for the expected payload format.

  Cancel Signature Request

  Cancels a signature request that is currently out for signing. Use this endpoint when a signature request must be withdrawn — for example, if the contract needs to be revised before it can be signed.

  • Enter the unique identifier of the workflow in the Workflow ID field. This value is required. The workflow must have an active signature request in progress for this action to succeed.
  • The request body may include a cancellation reason. Refer to the Ironclad Workflows API documentation for supported request body fields.

  Create a Recipient URL for a Signer

  Generates a signing URL for a specific recipient to access and sign a workflow document. Use this endpoint when you need to distribute a direct signing link to a counterparty outside of Ironclad's built-in notification system.

  • Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
  • The request body must include the signer's identity information to identify the correct recipient. Refer to the Ironclad Signatures API documentation for required fields.
  • The response will contain the generated signing URL, which can be distributed to the signer via email or another communication channel.

  Create an Embeddable Recipient URL for a Signer

  Generates an embeddable signing URL that enables a signer to complete their signature within an iframe embedded in your own application. Use this endpoint to build embedded signing experiences without redirecting the user to the Ironclad platform.

  • Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
  • The request body must include the signer's identity information. Refer to the Ironclad Signatures API documentation for required fields and iframe integration guidance.
  • The response will contain an embeddable URL. This URL is intended for use in an iframe element within your application and should not be shared as a plain link.

  Revert a Workflow to the Review Step

  Reverts an Ironclad workflow from the Sign step back to the Review step. Use this endpoint when a contract that has been sent for signing needs to be recalled for further review and revisions.

  • The Workflow ID must be included in the URL path. Provide the workflow ID in the Nexset or configure the endpoint URL accordingly. The workflow must be in the Sign step for this action to succeed.
  • No request body fields are required for this action. Refer to the Ironclad Workflows API documentation for additional details.

  Cancel a Workflow

  Cancels an active Ironclad workflow. Use this endpoint to programmatically cancel workflows that are no longer needed or were created in error.

  • The Workflow ID must be included in the URL path. Provide the workflow ID in the Nexset or configure the endpoint URL accordingly. Only active workflows (not already completed or cancelled) can be cancelled.
  • The request body may include a cancellation reason. Refer to the Ironclad Workflows API documentation for supported fields.

  Pause a Workflow

  Pauses an active workflow that is currently in the Review step. Use this endpoint to temporarily halt workflow progress without cancelling it — for example, when a contract negotiation needs to be put on hold pending further information.

  • The Workflow ID must be included in the URL path. The workflow must be in the Review step for this action to succeed.
  • The request body may include a reason for pausing. Refer to the Ironclad Workflows API documentation for supported fields.

  Resume a Workflow

  Resumes a previously paused Ironclad workflow. Use this endpoint to restart workflow progress after the reason for pausing has been resolved.

  • The Workflow ID must be included in the URL path. The workflow must be in a paused state for this action to succeed.
  • No additional request body fields are required. Refer to the Ironclad Workflows API documentation for additional details.

  Create a Comment on a Workflow

  Adds a comment to a workflow's activity feed. Use this endpoint to programmatically post notes, status updates, or contextual information to the workflow's collaboration timeline.

  • The Workflow ID must be included in the URL path. Provide the workflow ID in the Nexset or configure the endpoint URL accordingly.
  • The request body must include the comment text. Refer to the Ironclad Workflows API documentation for the expected request body format.

  Update Workflow Metadata

  Updates specific metadata attributes on a workflow that is currently in the Review step. Use this endpoint to programmatically update contract attributes — such as counterparty details, contract value, or custom fields — without requiring manual edits in the Ironclad UI.

  • The Workflow ID must be included in the URL path. The workflow must be in the Review step for attribute updates to be accepted.
  • The request body should include only the attributes to be updated, using the attribute IDs defined in your Ironclad workflow template. Refer to the Workflow Attribute IDs reference in the Ironclad Developer Hub for guidance on constructing the payload.

  Only attributes that correspond to editable fields in the workflow's Review step can be updated via this endpoint. Attempting to update attributes in a workflow that is in the Sign or Completed step will result in an error.

  Create a Record

  Creates a new contract record in the Ironclad Repository. Use this endpoint to programmatically add records for contracts that were negotiated and executed outside of Ironclad, enabling your organization to maintain a complete contract repository.

  • The request body must include the record's properties and record type. Required fields depend on the record type's schema in your Ironclad instance. Use the Retrieve Records Schema source endpoint to discover the available record types and their required fields before building this destination flow.

  • Optionally, include links to related workflows or other records, and any relationship data, as supported by the Ironclad Records API. Refer to the Create a Record guide in the Ironclad Developer Hub for complete payload documentation.

  Records in Ironclad represent completed or externally executed contracts stored in the Repository. Creating records via the API is commonly used to import legacy contracts or contracts executed outside of Ironclad workflows.

  Replace a Record

  Replaces the complete data of an existing record by ID. Use this endpoint for a full update of a record's properties and relationships — this operation overwrites all existing field values.

  • Enter the unique identifier of the record to replace in the Record ID field. This value is required.
  • The request body must include the complete record payload with all required fields. Fields omitted from the payload will be cleared. Refer to the Ironclad Records API documentation for payload requirements.

  :::warning Important This is a full-replacement operation. Any fields not included in the request payload will be removed from the record. Use the "Update Record Metadata" endpoint if you only need to modify specific fields. :::

  Update Record Metadata

  Partially updates specific fields on an existing Ironclad record. Use this endpoint when you need to update only certain attributes of a record without affecting other fields.

  • Enter the unique identifier of the record to update in the Record ID field. This value is required.
  • The request body should include only the fields to be updated. Fields not included in the payload will retain their current values. Refer to the Ironclad Records API documentation for supported fields and payload format.

  Delete a Record

  Permanently deletes an existing record from the Ironclad Repository by ID. Use this endpoint to remove records that were created in error or are no longer needed.

  • Enter the unique identifier of the record to delete in the Record ID field. This value is required.

  :::danger Important Record deletion is permanent and cannot be undone. Verify the Record ID before sending data to this endpoint, as there is no recovery option once the record is deleted. :::

Configure Manually

Ironclad destinations can be manually configured to send data to any valid Ironclad API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Ironclad API after each call to a new Nexla webhook data source.

API Method

1. To manually configure this destination, 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. Common Ironclad API methods include:

   • POST: For creating new workflows, records, comments, or initiating signing actions
   • PATCH: For partial updates to workflows or records
   • PUT: For full replacement of existing records
   • DELETE: For removing records

Data Format

3. Select the format in which the Nexset data will be sent to the Ironclad API from the Content Format pulldown menu. Most Ironclad API endpoints accept JSON (application/json). The create_record_attachment endpoint uses multipart/form-data for file uploads. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL

4. Enter the URL of the Ironclad API endpoint to which you want to send the Nexset data in the URL field. For update or delete operations, include the ID of the object to be updated or deleted at the end of the URL path.

Ironclad's public API base URL is your instance URL followed by /public/api/v1/. For example: https://na1.ironcladapp.com/public/api/v1/workflows. For SCIM-based user and group management endpoints, use the SCIM base path: https://na1.ironcladapp.com/scim/v2/. Refer to the Ironclad Developer Hub for the full endpoint reference.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this destination, 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.

Exclude Attributes from the Call

Optional

• If any record attributes in the Nexset should be omitted when sending data to this Ironclad destination, select the attributes from the Exclude Attributes pulldown menu.

• Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching

Optional

1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Response Webhook

Optional

Nexla can automatically send the response received from the Ironclad API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — for example, to capture the workflow ID returned after a successful workflow creation.

• To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload

Sample request payloads containing a portion of the Nexset data that will be sent to the Ironclad API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

• Click on a sample request payload to expand it and view the complete payload content.
• Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)

After all endpoint settings have been configured, Nexla can send a test payload to the Ironclad API to ensure that the destination is configured correctly.

1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Ironclad API using the current settings.

Save & Activate the Destination

• Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Ironclad endpoint, open the destination resource menu, and select Activate.

  The Nexset data will not be sent to Ironclad until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.