Update Workflow Metadata with Ironclad API

Pipedream makes it easy to connect APIs for Ironclad and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Update Workflow Metadata with the Ironclad API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Update Workflow Metadata with the Ironclad API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Update Workflow Metadata action
1. Connect your Ironclad account
2. Select a Workflow ID
3. Optional- Configure Comment
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Update Workflow Metadata with Ironclad API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Ironclad

Try it

Update Workflow Metadata with Ironclad API on New Submission from Typeform API

Typeform + Ironclad

Try it

Update Workflow Metadata with Ironclad API on New Submission (Instant) from Jotform API

Jotform + Ironclad

Try it

Update Workflow Metadata with Ironclad API on New Scheduled Tasks from Pipedream API

Pipedream + Ironclad

Try it

Update Workflow Metadata with Ironclad API on New Download Counts from npm API

npm + Ironclad

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Update Workflow Metadata on Ironclad

Description:Updates the metadata of an existing workflow. [See the documentation]()

Version:0.0.1

Key:ironclad-update-workflow

View on GitHub

Code#

import ironclad from "../../ironclad.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import {
  getAttributeDescription, parseValue,
} from "../../common/utils.mjs";

export default {
  key: "ironclad-update-workflow",
  name: "Update Workflow Metadata",
  description: "Updates the metadata of an existing workflow. [See the documentation]()",
  version: "0.0.1",
  type: "action",
  props: {
    ironclad,
    workflowId: {
      propDefinition: [
        ironclad,
        "workflowId",
      ],
      reloadProps: true,
    },
    comment: {
      type: "string",
      label: "Comment",
      description: "A comment that explains the updates you are making to the workflow",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.workflowId) {
      return props;
    }
    const { schema } = await this.ironclad.getWorkflow({
      workflowId: this.workflowId,
    });
    for (const [
      key,
      value,
    ] of Object.entries(schema)) {
      if (!value?.readOnly) {
        props[key] = {
          type: value.type === "boolean"
            ? "boolean"
            : value.type === "array"
              ? "string[]"
              : "string",
          label: value.displayName,
          description: getAttributeDescription(value),
          optional: true,
        };
        if (key === "paperSource") {
          props[key].options = [
            "Counterparty paper",
            "Our paper",
          ];
        }
      }
    }
    return props;
  },
  async run({ $ }) {
    const {
      ironclad,
      workflowId,
      comment,
      ...attributes
    } = this;

    const parsedAttributes = {};
    for (const [
      key,
      value,
    ] of Object.entries(attributes)) {
      parsedAttributes[key] = parseValue(value);
    }

    try {
      const response = await ironclad.updateWorkflowMetadata({
        $,
        workflowId: workflowId,
        data: {
          updates: Object.entries(parsedAttributes).map(([
            key,
            value,
          ]) => ({
            action: "set",
            path: key,
            value,
          })),
          comment: comment,
        },
      });
      $.export("$summary", `Workflow ${workflowId} updated successfully`);
      return response;
    } catch (error) {
      const msg = JSON.parse(error.message);
      const { schema } = await ironclad.getWorkflow({
        workflowId,
      });
      if (msg.code === "MISSING_PARAM") {
        const paramNames = (JSON.parse(msg.param)).map((p) => `\`${schema[p].displayName}\``);
        throw new ConfigurationError(`Please enter or update the following required parameters: ${paramNames.join(", ")}`);
      }
      if (msg.code === "INVALID_PARAM") {
        const paramName = schema[msg.metadata.keyPath].displayName;
        throw new ConfigurationError(`Invalid parameter: \`${paramName}\`. ${msg.message}`);
      }
      throw new ConfigurationError(msg.message);
    }
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Ironclad	`ironclad`	`app`	This component uses the Ironclad app.
Workflow ID	`workflowId`	`string`	Select a value from the drop down menu.
Comment	`comment`	`string`	A comment that explains the updates you are making to the workflow

Authentication#

Ironclad uses OAuth authentication. When you connect your Ironclad account, Pipedream will open a popup window where you can sign into Ironclad and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Ironclad API.

Pipedream requests the following authorization scopes when you connect your account:

scim.users.readUserspublic.workflows.readWorkflowspublic.records.readSchemaspublic.records.readRecordspublic.records.createRecordspublic.workflows.createWorkflowspublic.workflows.updateWorkflowspublic.webhooks.createWebhookspublic.webhooks.deleteWebhookspublic.workflows.readSchemas