Send Document Using Template with BoldSign API on New Response Received (Instant) from Zoho Forms API

Pipedream makes it easy to connect APIs for BoldSign, Zoho Forms and 2,700+ other apps remarkably fast.

Trigger workflow on

New Response Received (Instant) from the Zoho Forms API

Next, do this

Send Document Using Template with the BoldSign 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 Zoho Forms trigger and BoldSign action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Response Received (Instant) trigger
1. Connect your Zoho Forms account
2. Select a Form Link Name
Configure the Send Document Using Template action
1. Connect your BoldSign account
2. Select a Template ID
3. Optional- Configure Title
4. Optional- Configure Message
5. Configure Roles
6. Optional- Select a Brand ID
7. Optional- Configure Labels
8. Optional- Configure Disable Emails
9. Optional- Configure Disable SMS
10. Optional- Configure Hide Document ID
11. Optional- Configure Enable Auto Reminder
12. Optional- Configure Reminder Days
13. Optional- Configure Reminder Count
14. Optional- Select one or more CC
15. Optional- Configure Expiry Days
16. Optional- Configure Enable Print and Sign
17. Optional- Configure Enable Reassign
18. Optional- Configure Enable Signing Order
19. Optional- Configure Disable Expiry Alert
20. Optional- Configure Document Info
21. Optional- Configure Role Removal Indices
22. Optional- Select a Document Download Option
23. Optional- Configure Form Groups
24. Optional- Configure File Paths or URLs
25. Optional- Configure File URLs
26. Optional- Configure Recipient Notification Settings
27. Optional- Configure Remove Formfields
28. Optional- Configure Enable Audit Trail Localization
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 Response Received (Instant) on Zoho Forms

Description:Emit new event when a specific form receive a new response.

Version:0.0.1

Key:zoho_forms-new-response-received-instant

View on GitHub

Zoho Forms Overview#

Zoho Forms API allows you to automate interactions with your forms and the data you collect. Leveraging Pipedream, you can harness this API to trigger workflows upon new form submissions, manipulate form entries, and sync data with other services. Pipedream’s serverless platform simplifies integrating Zoho Forms with hundreds of other apps, empowering you to create custom, scalable workflows without hosting or managing servers.

Trigger Code#

import zohoForms from "../../zoho_forms.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "zoho_forms-new-response-received-instant",
  name: "New Response Received (Instant)",
  description: "Emit new event when a specific form receive a new response.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    zohoForms,
    db: "$.service.db",
    http: "$.interface.http",
    formLinkName: {
      propDefinition: [
        zohoForms,
        "formLinkName",
      ],
    },
  },
  methods: {
    setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    getHookId() {
      return this.db.get("hookId");
    },
  },
  hooks: {
    async activate() {
      const response = await this.zohoForms.createHook({
        params: {
          "webhooks_url": this.http.endpoint,
          "formlinkname": this.formLinkName,
        },
      });

      this.setHookId(response.webhook_id);
    },
    async deactivate() {
      await this.zohoForms.deleteHook({
        params: {
          "webhook_id": this.getHookId(),
          "formlinkname": this.formLinkName,
        },
      });
    },
  },
  async run({ body }) {
    const ts = Date.parse(body.ADDED_TIME_ISO8601);

    this.$emit(body, {
      id: body.IP_ADDRESS + ts,
      summary: "New response received",
      ts: ts,
    });
  },
  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
Zoho Forms	`zohoForms`	`app`	This component uses the Zoho Forms app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Form Link Name	`formLinkName`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

ZohoForms.forms.READ

About Zoho Forms#

Build powerful forms for free, share them online, receive instant alerts, and efficiently manage your data with our integrated apps. Focus on your business while Zoho Forms handles the data collection process for you!

Action#

Send Document Using Template on BoldSign

Description:Send documents for e-signature using a BoldSign template. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template/?region=us)

Version:0.1.0

Key:boldsign-send-document-template

View on GitHub

Action Code#

import {
  ConfigurationError, getFileStreamAndMetadata,
} from "@pipedream/platform";
import boldsign from "../../boldsign.app.mjs";
import { DOCUMENT_DOWNLOAD_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "boldsign-send-document-template",
  name: "Send Document Using Template",
  description: "Send documents for e-signature using a BoldSign template. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template/?region=us)",
  version: "0.1.0",
  type: "action",
  props: {
    boldsign,
    templateId: {
      propDefinition: [
        boldsign,
        "templateId",
      ],
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the document.",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "A message to include with the document.",
      optional: true,
    },
    roles: {
      type: "string[]",
      label: "Roles",
      description: "A role is simply a placeholder for a real person. For example, if we have a purchase order that will always be signed by two people, one from the company and one from the customer, we can create a template with two roles Customer and Representative. Example: **[{\"roleIndex\": 50,\"signerName\": \"Richard\",\"signerOrder\": 1,\"signerEmail\": \"richard@cubeflakes.com\",\"privateMessage\": \"Please check and sign the document.\",\"authenticationCode\": \"281028\",\"enableEmailOTP\": false,\"signerType\": \"Signer\",\"signerRole\": \"Manager\",\"formFields\": [{\"id\": \"SignField\",\"fieldType\": \"Signature\",\"pageNumber\": 1,\"bounds\": {\"x\": 100,\"y\": 100,\"width\": 100,\"height\": 50},\"isRequired\": true}]**.",
    },
    brandId: {
      propDefinition: [
        boldsign,
        "brandId",
      ],
      optional: true,
    },
    labels: {
      propDefinition: [
        boldsign,
        "labels",
      ],
      optional: true,
    },
    disableEmails: {
      type: "boolean",
      label: "Disable Emails",
      description: "Disable sending emails to recipients.",
      optional: true,
    },
    disableSMS: {
      type: "boolean",
      label: "Disable SMS",
      description: "Disable sending SMS to recipients.",
      optional: true,
    },
    hideDocumentId: {
      type: "boolean",
      label: "Hide Document ID",
      description: "Decides whether the document ID should be hidden or not.",
      optional: true,
    },
    enableAutoReminder: {
      type: "boolean",
      label: "Enable Auto Reminder",
      description: "Enable automatic reminders.",
      reloadProps: true,
      optional: true,
    },
    reminderDays: {
      type: "integer",
      label: "Reminder Days",
      description: "Number of days between reminders.",
      hidden: true,
      optional: true,
    },
    reminderCount: {
      type: "integer",
      label: "Reminder Count",
      description: "Number of reminder attempts.",
      hidden: true,
      optional: true,
    },
    cc: {
      propDefinition: [
        boldsign,
        "cc",
      ],
      optional: true,
    },
    expiryDays: {
      type: "integer",
      label: "Expiry Days",
      description: "Number of days before document expires.",
      optional: true,
    },
    enablePrintAndSign: {
      type: "boolean",
      label: "Enable Print and Sign",
      description: "Allow signers to print and sign document.",
      optional: true,
    },
    enableReassign: {
      type: "boolean",
      label: "Enable Reassign",
      description: "Allow signers to reassign the document.",
      optional: true,
    },
    enableSigningOrder: {
      type: "boolean",
      label: "Enable Signing Order",
      description: "Enable signing order for the document.",
      optional: true,
    },
    disableExpiryAlert: {
      type: "boolean",
      label: "Disable Expiry Alert",
      description: "Disable alerts before document expiry.",
      optional: true,
    },
    documentInfo: {
      type: "string[]",
      label: "Document Info",
      description: "Custom information fields for the document. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template) for further information.",
      optional: true,
    },
    roleRemovalIndices: {
      type: "integer[]",
      label: "Role Removal Indices",
      description: "Removes the roles present in the template with their indices given in this property.",
      optional: true,
    },
    documentDownloadOption: {
      type: "string",
      label: "Document Download Option",
      description: "Option for document download configuration.",
      options: DOCUMENT_DOWNLOAD_OPTIONS,
      optional: true,
    },
    formGroups: {
      type: "string[]",
      label: "Form Groups",
      description: "Manages the rules and configuration of grouped form fields. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template) for further information.",
      optional: true,
    },
    files: {
      type: "string[]",
      label: "File Paths or URLs",
      description: "The files to upload. For each entry, provide either a file URL or path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)",
      optional: true,
    },
    fileUrls: {
      type: "string[]",
      label: "File URLs",
      description: "URLs of files to include in the document.",
      optional: true,
    },
    recipientNotificationSettings: {
      type: "object",
      label: "Recipient Notification Settings",
      description: "Settings for recipient notifications. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template) for further information.",
      optional: true,
    },
    removeFormfields: {
      type: "string[]",
      label: "Remove Formfields",
      description: "The removeFormFields property in API allows you to exclude specific form fields from a document before sending it. You provide a string array with the IDs of the existing form fields you want to remove. One or more values can be specified.",
      optional: true,
    },
    enableAuditTrailLocalization: {
      type: "boolean",
      label: "Enable Audit Trail Localization",
      description: "Enable localization for audit trail based on the signer's language. If null is provided, the value will be inherited from the Business Profile settings. Only one additional language can be specified in the signer's languages besides English.",
      optional: true,
    },
  },
  async additionalProps(props) {
    props.reminderDays.hidden = !this.enableAutoReminder;
    props.reminderCount.hidden = !this.enableAutoReminder;
    return {};
  },
  async run({ $ }) {
    try {
      const files = [];
      if (this.files) {
        for (const file of parseObject(this.files)) {
          const {
            stream, metadata,
          } = await getFileStreamAndMetadata(file);
          const chunks = [];
          for await (const chunk of stream) {
            chunks.push(chunk);
          }
          const buffer = Buffer.concat(chunks);
          files.push(`data:${metadata.contentType};base64,${buffer.toString("base64")}`);
        }
      }

      const additionalData = {};
      if (this.enableAutoReminder) {
        additionalData.reminderSettings = {
          enableAutoReminder: this.enableAutoReminder,
          reminderDays: this.reminderDays,
          reminderCount: this.reminderCount,
        };
      }

      const response = await this.boldsign.sendDocument({
        $,
        headers: {
          "Content-Type": "application/json;odata.metadata=minimal;odata.streaming=true",
        },
        params: {
          templateId: this.templateId,
        },
        data: {
          title: this.title,
          message: this.message,
          roles: parseObject(this.roles),
          brandId: this.brandId,
          labels: parseObject(this.labels),
          disableEmails: this.disableEmails,
          disableSMS: this.disableSMS,
          hideDocumentId: this.hideDocumentId,
          reminderSettings: {
            enableAutoReminder: this.enableAutoReminder,
            reminderDays: this.reminderDays,
            reminderCount: this.reminderCount,
          },
          cc: parseObject(this.cc)?.map((item) => ({
            emailAddress: item,
          })),
          expiryDays: this.expiryDays,
          enablePrintAndSign: this.enablePrintAndSign,
          enableReassign: this.enableReassign,
          enableSigningOrder: this.enableSigningOrder,
          disableExpiryAlert: this.disableExpiryAlert,
          documentInfo: parseObject(this.documentInfo),
          roleRemovalIndices: parseObject(this.roleRemovalIndices),
          documentDownloadOption: this.documentDownloadOption,
          formGroups: parseObject(this.formGroups),
          files,
          fileUrls: parseObject(this.fileUrls),
          recipientNotificationSettings: parseObject(this.recipientNotificationSettings),
          removeFormfields: parseObject(this.removeFormfields),
          enableAuditTrailLocalization: this.enableAuditTrailLocalization,
          ...additionalData,
        },
      });
      $.export("$summary", `Document sent successfully using template ${this.templateId}`);
      return response;
    } catch ({ message }) {
      const parsedMessage = JSON.parse(message);
      let errorMessage = "";
      if (parsedMessage.error) errorMessage = parsedMessage.error;
      if (parsedMessage.errors) {
        Object.entries(parsedMessage.errors).map(([
          ,
          value,
        ]) => {
          errorMessage += `- ${value[0]}\n`;
        });
      }
      throw new ConfigurationError(errorMessage);
    }
  },
};

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
BoldSign	`boldsign`	`app`	This component uses the BoldSign app.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	The title of the document.
Message	`message`	`string`	A message to include with the document.
Roles	`roles`	`string[]`	A role is simply a placeholder for a real person. For example, if we have a purchase order that will always be signed by two people, one from the company and one from the customer, we can create a template with two roles Customer and Representative. Example: [{"roleIndex": 50,"signerName": "Richard","signerOrder": 1,"signerEmail": "richard@cubeflakes.com","privateMessage": "Please check and sign the document.","authenticationCode": "281028","enableEmailOTP": false,"signerType": "Signer","signerRole": "Manager","formFields": [{"id": "SignField","fieldType": "Signature","pageNumber": 1,"bounds": {"x": 100,"y": 100,"width": 100,"height": 50},"isRequired": true}].
Brand ID	`brandId`	`string`	Select a value from the drop down menu.
Labels	`labels`	`string[]`	Labels for categorizing documents.
Disable Emails	`disableEmails`	`boolean`	Disable sending emails to recipients.
Disable SMS	`disableSMS`	`boolean`	Disable sending SMS to recipients.
Hide Document ID	`hideDocumentId`	`boolean`	Decides whether the document ID should be hidden or not.
Enable Auto Reminder	`enableAutoReminder`	`boolean`	Enable automatic reminders.
CC	`cc`	`string[]`	Select a value from the drop down menu.
Expiry Days	`expiryDays`	`integer`	Number of days before document expires.
Enable Print and Sign	`enablePrintAndSign`	`boolean`	Allow signers to print and sign document.
Enable Reassign	`enableReassign`	`boolean`	Allow signers to reassign the document.
Enable Signing Order	`enableSigningOrder`	`boolean`	Enable signing order for the document.
Disable Expiry Alert	`disableExpiryAlert`	`boolean`	Disable alerts before document expiry.
Document Info	`documentInfo`	`string[]`	Custom information fields for the document. See the documentation for further information.
Role Removal Indices	`roleRemovalIndices`	`integer[]`	Removes the roles present in the template with their indices given in this property.
Document Download Option	`documentDownloadOption`	`string`	Select a value from the drop down menu:`CombinedIndividually`
Form Groups	`formGroups`	`string[]`	Manages the rules and configuration of grouped form fields. See the documentation for further information.
File Paths or URLs	`files`	`string[]`	The files to upload. For each entry, provide either a file URL or path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)
File URLs	`fileUrls`	`string[]`	URLs of files to include in the document.
Recipient Notification Settings	`recipientNotificationSettings`	`object`	Settings for recipient notifications. See the documentation for further information.
Remove Formfields	`removeFormfields`	`string[]`	The removeFormFields property in API allows you to exclude specific form fields from a document before sending it. You provide a string array with the IDs of the existing form fields you want to remove. One or more values can be specified.
Enable Audit Trail Localization	`enableAuditTrailLocalization`	`boolean`	Enable localization for audit trail based on the signer's language. If null is provided, the value will be inherited from the Business Profile settings. Only one additional language can be specified in the signer's languages besides English.

Action Authentication#

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

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

offline_accessBoldSign.Users.ReadBoldSign.Documents.WriteBoldSign.Documents.CreateBoldSign.Templates.ReadBoldSign.Templates.WriteBoldSign.Templates.CreateBoldSign.SenderIdentity.ReadBoldSign.Documents.ReadBoldSign.Contacts.Read