Skip to main content
You must be an Ironclad admin to create an OAuth (API) client. Create one under Company Settings → API.

Create an OAuth client in Ironclad

Register an OAuth client to obtain a Client ID and Client Secret.

1

Open API settings

Sign in to Ironclad and open the API settings.

  • Go to Company Settings → API.
  • Open the Client Applications / OAuth Apps section.
2

Create the client

Create a new OAuth client application.

  • Click Create Client Application.
3

Select scopes

Enables actions: Cancel A Workflow, Cancel Signature Request, Check Data Export Job Status, Contract Status Changed, Create A Comment On A Workflow, Create A Record, Create A Webhook, Create A Workflow Synchronously, Create An Attachment On A Record, Create An Entity, Create An Obligation, Delete A Record, Delete A Webhook, Delete An Attachment On A Record, Delete An Entity, Download Data Export File, Get All Entity Relationship Types, List A Comment From A Specified Workflow, List All Comments On A Workflow, List All Entities, List All Obligations, List All Records, List All Webhooks, List All Workflow Approvals, List All Workflow Participants, List All Workflow Schemas, List All Workflow Signers, List All Workflows, Pause A Workflow, Replace A Record, Resume A Workflow, Retrieve A Record, Retrieve A Webhook, Retrieve A Workflow, Retrieve A Workflow Document, Retrieve A Workflow Schema, Retrieve An Attachment On A Record, Retrieve An Entity, Retrieve An Obligation, Retrieve Documents From A Workflow, Retrieve Records Schema, Retrieve Sign Step Status, Retrieve The Turn History On A Workflow, Run An Action On A Record, Send Signature Request, Signature Packet Cancelled, Signature Packet Fully Signed, Signature Packet Sent, Submit A Request To Generate A New Data Export, Update A Webhook, Update An Entity, Update An Obligation, Update Approval Status On A Workflow, Update Record Metadata, Update Workflow Metadata, Workflow Approval Status Changed, Workflow Attribute Updated, Workflow Cancelled, Workflow Comment Added, Workflow Completed, Workflow Launched, Workflow Paused, Workflow Resumed

Grant the client the scopes required by the actions you will use.

4

Copy credentials

Copy the generated credentials.

  • Copy the Client ID across.
  • Copy the Client Secret across. Ironclad shows it once.

Choose your region

Pick the Server Domain that matches your Ironclad account host (shown in your Ironclad URL).

  • na1.ironcladapp.com → North America (na1)
  • eu1.ironcladapp.com → Europe (eu1)
  • demo.ironcladapp.com → Demo
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.