Create Signature Request with IgniSign API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

Create Signature Request with the IgniSign 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#

This integration creates a workflow with a Schedule trigger and IgniSign action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Signature Request action
1. Connect your IgniSign account
2. Select one or more Signer IDs
3. Optional- Configure Document Label
4. Optional- Configure Document Description
5. Optional- Configure Document External Id
6. Configure Document File
7. Configure Title
8. Optional- Configure Description
9. Optional- Configure Expiration Date Is Activated
10. Optional- Configure Expiration Date
11. Optional- Select a Language
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Weekly schedule on Schedule

Description:Trigger your workflow on one or more days each week at a specific time (with timezone support).

Version:0.0.1

Key:schedule-weekly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 * * 1",
      },
    },
  },
};

Trigger 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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Signature Request on IgniSign

Description:Creates a document signature request through IgniSign. [See the documentation](https://ignisign.io/docs/ignisign-api/init-signature-request)

Version:0.0.1

Key:ignisign-create-signature-request

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import FormData from "form-data";
import fs from "fs";
import { LANGUAGE_OPTIONS } from "../../common/constants.mjs";
import {
  checkTmp, parseObject,
} from "../../common/utils.mjs";
import ignisign from "../../ignisign.app.mjs";

export default {
  key: "ignisign-create-signature-request",
  name: "Create Signature Request",
  description: "Creates a document signature request through IgniSign. [See the documentation](https://ignisign.io/docs/ignisign-api/init-signature-request)",
  version: "0.0.1",
  type: "action",
  props: {
    ignisign,
    signerIds: {
      propDefinition: [
        ignisign,
        "signerIds",
      ],
    },
    documentLabel: {
      type: "string",
      label: "Document Label",
      description: "A user-friendly label to identify the document.",
      optional: true,
    },
    documentDescription: {
      type: "string",
      label: "Document Description",
      description: "A detailed, human-readable description of the document.",
      optional: true,
    },
    documentExternalId: {
      type: "string",
      label: "Document External Id",
      description: "An optional external identifier that can be used to reference the document from external systems. It's a free text. Ignisign's system do not interprete it.",
      optional: true,
    },
    file: {
      type: "string",
      label: "Document File",
      description: "The file to be uploaded, please provide a file from `/tmp`. To upload a file to `/tmp` folder, please follow the doc [here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the signature request.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the signature request.",
      optional: true,
    },
    expirationDateIsActivated: {
      type: "boolean",
      label: "Expiration Date Is Activated",
      description: "Indicates whether the expiration date is activated.",
      reloadProps: true,
      optional: true,
    },
    expirationDate: {
      type: "string",
      label: "Expiration Date",
      description: "The expiration date. The action linked to this date is performed every 5 minutes, at 5, 10, 15... 55.",
      optional: true,
      hidden: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "Represents the languages for signatures supported by a signature profile.",
      options: LANGUAGE_OPTIONS,
      optional: true,
    },
  },
  async additionalProps(props) {
    props.expirationDate.hidden = !this.expirationDateIsActivated;
    return {};
  },
  async run({ $ }) {
    const data = new FormData();

    const { signatureRequestId } = await this.ignisign.initSignatureRequest();

    const { documentId } = await this.ignisign.initDocument({
      data: {
        signatureRequestId,
        label: this.documentLabel,
        description: this.documentDescription,
        externalId: this.documentExternalId,
      },
    });

    const path = checkTmp(this.file);
    if (!fs.existsSync(path)) {
      await this.ignisign.closeSignatureRequest({
        signatureRequestId,
      });
      throw new ConfigurationError("File does not exist!");
    }
    const file = fs.createReadStream(path);
    data.append("file", file);

    await this.ignisign.uploadFile({
      documentId,
      data,
      headers: data.getHeaders(),
    });

    await this.ignisign.updateSignatureRequest({
      signatureRequestId,
      data: {
        title: this.title,
        description: this.description,
        expirationDateIsActivated: this.expirationDateIsActivated,
        expirationDate: this.expirationDate,
        language: this.language,
        documentIds: [
          documentId,
        ],
        signerIds: parseObject(this.signerIds),
      },
    });

    await this.ignisign.publishSignatureRequest({
      $,
      signatureRequestId,
    });

    $.export("$summary", `Successfully published signature request with ID ${signatureRequestId}`);
    return {
      signatureRequestId,
    };
  },
};

Action Configuration#

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

Label	Prop	Type	Description
IgniSign	`ignisign`	`app`	This component uses the IgniSign app.
Signer IDs	`signerIds`	`string[]`	Select a value from the drop down menu.
Document Label	`documentLabel`	`string`	A user-friendly label to identify the document.
Document Description	`documentDescription`	`string`	A detailed, human-readable description of the document.
Document External Id	`documentExternalId`	`string`	An optional external identifier that can be used to reference the document from external systems. It's a free text. Ignisign's system do not interprete it.
Document File	`file`	`string`	The file to be uploaded, please provide a file from `/tmp`. To upload a file to `/tmp` folder, please follow the doc here
Title	`title`	`string`	The title of the signature request.
Description	`description`	`string`	The description of the signature request.
Expiration Date Is Activated	`expirationDateIsActivated`	`boolean`	Indicates whether the expiration date is activated.
Language	`language`	`string`	Select a value from the drop down menu:`ENFRDEESITPTNLPLJAKOARHE`

Action Authentication#

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

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