Skip to main content

​
About Ironclad

Ironclad is a digital contracting platform that streamlines the entire contract lifecycle - from creation and negotiation to signature and management. Connecting Ironclad to Serval enables automated contract workflows, approvals management, and document tracking directly from your service desk.

​
What the Ironclad integration enables

CapabilityDescription
Workflow ManagementCreate, read, and update workflows including approvals and document management
Records ManagementCreate, read, update and delete contract records
Document OperationsUpload documents, retrieve signed documents, and manage attachments
Automation workflowsStreamline contract approvals, automate document routing, and more
Anything defined in the Ironclad API can be accessed through Serval.

​
Ironclad Configuration

​
Prerequisites

  • You must have admin access to your Ironclad account
  • You must have the API add-on enabled for your Ironclad instance

​
1. Create an OAuth Client Application

  1. In Ironclad, click on your user profile dropdown at the top right-hand corner and select Company Settings
  2. Select the API tab on the left sidebar
The “API” tab will only be visible if you have the API add-on enabled for your instance.
  1. Click on the Create new app button
  2. Enter a name for your OAuth application (e.g., “Serval Integration”) and click Create app
  3. Save the generated Client ID and Client Secret immediately
Save the Client Secret securely - you will not be able to access it again after closing the modal.

​
2. Configure the OAuth Application

After creating the app, configure the following settings:
  1. Title: Enter “Serval Integration” (this will appear in authorization dialogs)
  2. Description: Add “Integration with Serval for automated workflows”
  3. Grant Types: Select only “Client Credentials”
Make sure only “Client Credentials” is selected as the grant type. Do not enable “Authorization Code” grant.
  1. Redirect URIs: Leave this blank (not needed for Client Credentials flow)
  2. Requested Resource Scopes: Add the following scopes based on your needs:
public.workflows.readSchemas
public.workflows.readWorkflows
public.workflows.createWorkflows
public.workflows.updateWorkflows
public.workflows.createComments
public.workflows.readApprovals
public.workflows.updateApprovals
public.workflows.readDocuments
public.records.readSchemas
public.records.readRecords
public.records.createRecords
public.records.updateRecords
public.records.deleteRecords
public.webhooks.createWebhooks
public.webhooks.deleteWebhooks
Recommended scopes for Serval (comma-separated): 
public.workflows.readSchemas, public.workflows.readWorkflows, public.workflows.createWorkflows, public.workflows.updateWorkflows, public.workflows.createComments, public.workflows.readApprovals, public.workflows.updateApprovals, public.workflows.readDocuments, public.records.readSchemas, public.records.readRecords, public.records.createRecords, public.records.updateRecords, public.records.deleteRecords, public.webhooks.createWebhooks, public.webhooks.deleteWebhooks
  1. Click Save Changes

​
3. Identify Admin User Email

The Ironclad API requires all requests to include an admin user email for permission scoping. You’ll need to identify an appropriate admin user:
According to Ironclad’s documentation, API requests must include either the x-as-user-id or x-as-user-email header to specify who the request is being made on behalf of within the company.
Choose one of the following:
  • An existing admin user with full permissions in Ironclad
  • A dedicated service account user with admin privileges
The user email you provide must have sufficient permissions in Ironclad to perform all the actions your workflows require. API requests will be scoped to this user’s permissions.

​
Serval Configuration

  1. In Serval, navigate to Apps → Available → Ironclad → Connect
  2. Enter the following information:
    FieldDescription
    API Base URLYour Ironclad API domain (e.g., na1.ironcladapp.com for US, eu1.ironcladapp.com for EU)
    Client IDThe OAuth Client ID from your Ironclad application settings
    Client SecretThe OAuth Client Secret from your Ironclad application settings
    Admin Email (Optional)Email address of an admin user or service account for impersonation. This will be sent as x-as-user-email header in API requests. Leave blank if not using impersonation.
    ScopesComma-separated list of scopes (copy from the recommended list above)
  3. Click Save
You should now be able to build workflows that leverage Ironclad APIs, such as creating contracts, managing approvals, or retrieving signed documents.

​
Environment Support

Ironclad has multiple environments that operate independently:
EnvironmentDomainPurpose
NA Productionna1.ironcladapp.comUS production environment
EU Productioneu1.ironcladapp.comEU production environment
Demodemo.ironcladapp.comDemo environment
Previewpreview.ironcladapp.comPreview environment
Client applications created in one environment cannot be used in another. You’ll need to create separate OAuth applications for each environment you want to connect.
Need help? Contact support@serval.com for assistance with your Ironclad integration.