Move Contract Stage with fynk API

Pipedream makes it easy to connect APIs for fynk and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Move Contract Stage with the fynk 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 Move Contract Stage with the fynk API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Move Contract Stage action
1. Connect your fynk account
2. Select a Document
3. Select a Target Stage
4. Optional- Select a Signature Type
5. Optional- Configure Sequential Signing
6. Optional- Configure Message
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

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.

Move Contract Stage on fynk

Description:Move a contract forward in Fynk's lifecycle. See documentation pages [move document to review stage](https://app.fynk.com/v1/docs#/operations/v1.documents.stage-transitions.review) and [move document to signing stage](https://app.fynk.com/v1/docs#/operations/v1.documents.stage-transitions.signing).

Version:0.0.1

Key:fynk-move-contract-stage

View on GitHub

Code#

import fynk from "../../fynk.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "fynk-move-contract-stage",
  name: "Move Contract Stage",
  description: "Move a contract forward in Fynk's lifecycle. See documentation pages [move document to review stage](https://app.fynk.com/v1/docs#/operations/v1.documents.stage-transitions.review) and [move document to signing stage](https://app.fynk.com/v1/docs#/operations/v1.documents.stage-transitions.signing).",
  version: "0.0.1",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    fynk,
    documentUuid: {
      propDefinition: [
        fynk,
        "documentUuid",
      ],
    },
    targetStage: {
      propDefinition: [
        fynk,
        "targetStage",
      ],
    },
    signatureType: {
      type: "string",
      label: "Signature Type",
      description: "The signature type to use when moving to signing stage. Only used when `Target Stage` is set to `signing`",
      optional: true,
      options: [
        {
          label: "Simple Electronic Signature (SES)",
          value: "ses",
        },
        {
          label: "Advanced Electronic Signature (AES)",
          value: "aes",
        },
        {
          label: "Qualified Electronic Signature (QES)",
          value: "qes",
        },
      ],
    },
    sequentialSigning: {
      type: "boolean",
      label: "Sequential Signing",
      description: "If `true`, signatures will be requested in the order defined by the signatories' `signing_order`. Only used when `Target Stage` is set to `signing`",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "Message to include in the email sent to the document's signatories. This is included in addition to the default email text provided by fynk. Only used when `Target Stage` is set to `signing`",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      documentUuid,
      targetStage,
      signatureType,
      sequentialSigning,
      message,
    } = this;

    let response;
    if (targetStage === "review") {
      response = await this.fynk.moveDocumentToReview({
        $,
        documentUuid,
      });
    } else if (targetStage === "signing") {
      const data = {
        signature_type: signatureType,
        sequential_signing: sequentialSigning,
        message,
      };

      response = await this.fynk.moveDocumentToSigning({
        $,
        documentUuid,
        data,
      });
    } else {
      throw new ConfigurationError(`Invalid target stage: ${targetStage}`);
    }

    $.export("$summary", `Successfully moved contract ${documentUuid} to ${targetStage} stage`);
    return response;
  },
};

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
fynk	`fynk`	`app`	This component uses the fynk app.
Document	`documentUuid`	`string`	Select a value from the drop down menu.
Target Stage	`targetStage`	`string`	Select a value from the drop down menu:`{ "label": "Review", "value": "review" }{ "label": "Signing", "value": "signing" }`
Signature Type	`signatureType`	`string`	Select a value from the drop down menu:`{ "label": "Simple Electronic Signature (SES)", "value": "ses" }{ "label": "Advanced Electronic Signature (AES)", "value": "aes" }{ "label": "Qualified Electronic Signature (QES)", "value": "qes" }`
Sequential Signing	`sequentialSigning`	`boolean`	If `true`, signatures will be requested in the order defined by the signatories' `signing_order`. Only used when `Target Stage` is set to `signing`
Message	`message`	`string`	Message to include in the email sent to the document's signatories. This is included in addition to the default email text provided by fynk. Only used when `Target Stage` is set to `signing`