Create Signature Request with IgniSign API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream 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 Pipedream 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 New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
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 Path or URL
7. Configure Title
8. Optional- Configure Description
9. Optional- Configure Expiration Date Is Activated
10. Optional- Configure Expiration Date
11. Optional- Select a Language
12. Optional- Configure syncDir
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#

New Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

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:1.0.2

Key:ignisign-create-signature-request

View on GitHub

Action Code#

import {
  ConfigurationError, getFileStreamAndMetadata,
} from "@pipedream/platform";
import FormData from "form-data";
import { LANGUAGE_OPTIONS } from "../../common/constants.mjs";
import { 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: "1.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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 Path or URL",
      description: "Provide a file URL or a path to a file in the `/tmp` directory.",
    },
    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,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      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,
      },
    });

    try {
      const {
        stream, metadata,
      } = await getFileStreamAndMetadata(this.file);
      data.append("file", stream, {
        filename: metadata.name,
      });
    } catch (error) {
      await this.ignisign.closeSignatureRequest({
        signatureRequestId,
      });
      throw new ConfigurationError(`File handling failed: ${error.message}`);
    }

    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 Path or URL	`file`	`string`	Provide a file URL or a path to a file in the `/tmp` directory.
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`
syncDir	`syncDir`	`dir`

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:

Try it

Get Signature Proof with IgniSign API on New Scheduled Tasks from Pipedream API

Pipedream + IgniSign

Try it

Create Signature Request with IgniSign API on Card Due Date Reminder from Pipedream API

Pipedream + IgniSign

Try it

Create Signer with IgniSign API on Card Due Date Reminder from Pipedream API

Pipedream + IgniSign

Try it

Get Signature Proof with IgniSign API on Card Due Date Reminder from Pipedream API

Pipedream + IgniSign

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it

New Signature Proof Instant from the IgniSign API

Emit new event when a signature proof is generated. See the documentation

Try it