About the Ironclad category

o.plokha · February 27, 2025, 10:14am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Ironclad API Reference

Connector package documentation

1. Setting up HTTP Client Ironclad

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Ironclad HTTP Client as PlatForm and click next step
Select a server where you want to use Ironclad.
Select authentication type you want for the OAuth 2.
Fill in the Client ID, Client Secret and Scope.
(See the Ironclad Authentication Documentation)
Click on “Grant access to Ironclad” and you will be redirected to approve the grant for Authorization Code Grant. The key will be generated after this process complete.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

Note

You will need to add special header of x-as-user-id or x-as-user-email in the Subscriber or Publisher if you choose the Client Credentials Grant. You can do this by adding plugins in Advanced tab in the Subscriber or Publisher.

The scope of the OAuth need to be defined first when creating Apps inside Ironclad.

2. Subscribing to Entities from Ironclad

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Ironclad Subscriber” as the subscriber.
Select the entity you want to subscribe to from Ironclad.
Add any request parameters needed to subscribe to the entity.
Select the Ironclad HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Ironclad.
You can also optionally enable pagination to allow Alumio to fetch paginated entities.

2.2 General Concept

We follow the Ironclad documentation on building this connector, so you can easily use the connector based on Ironclad API Reference.

Entity

The entity you want to subscribe to Ironclad. Please refer to the entities from Ironclad API Reference page.

Request Parameters

You can provide these parameters to get the needed entity based on the Ironclad API Reference.

Please look at the example below on how to fill path field when we want retrieve list of comments on a workflow by subscribing “Workflows - List all Comments on a Workflow” entity.

From the end point, we can see that we need to set the id as a parameter. That is why we set the “id” inside the path key in the Request Parameters.

You can also notice that Ironclad requires a specific OAuth scope in for the end points to work, so please add the scope public.workflows.readComments to use this end point.

Alumio will then make a request to Ironclad with the URL /public/api/v1/workflows/67b5efa6ca7ddad515c1e57b/comments

Path is the path parameter of the URL. For example the {id}.
Query is a defined set of parameters attached to the end of a URL.
Example: www.url.com?type=true&start=0

HTTP Client

The HTTP Client configuration you will use to access Ironclad.

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Ironclad Publisher” as the publisher.
Select the Method you want the publisher to use with the data.
Select the Ironclad entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify body parameters on key “payload” from the data.

Method

Currently, we support HTTP Post method, HTTP Put method, HTTP Patch method and HTTP Delete method on submitting data to Ironclad.

Entity

We support publishing to all Ironclad endpoints.
Please refer to Ironclad API Reference page.

For example, we want to create a comment on a workflow. Please select “Post” as the Method and “Workflows - Create a Comment on a Workflow”.

From the documentation, we can see that we need to set a path parameter and a body parameter. That is why we set the “id” inside the path key and body parameters inside the payload key in the data.

You can also notice that Ironclad requires a specific OAuth scope in for the end points to work, so please add the scope public.workflows.createComments to use this end point.

Alumio will send an API request to Ironclad with URL /public/api/v1/workflows/67b5efa6ca7ddad515c1e57b/comments

Path is the path parameter of the URL. For example the {id}.
Query is a defined set of parameters attached to the end of a URL.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.