Send Document Using Template with BoldSign API on Failed Task in Schema from Snowflake API

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

Trigger workflow on

Failed Task in Schema from the Snowflake 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 Snowflake 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 Failed Task in Schema trigger
1. Connect your Snowflake account
2. Configure timer
3. Select a Database
4. Select one or more Schema
5. Optional- Configure Task 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 Files
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#

Failed Task in Schema on Snowflake

Description:Emit new events when a task fails in a database schema

Version:0.1.2

Key:snowflake-failed-task-in-schema

View on GitHub

Snowflake Overview#

Snowflake offers a cloud database and related tools to help developers create robust, secure, and scalable data warehouses. See Snowflake's Key Concepts & Architecture.

Getting Started

1. Create a user, role and warehouse in Snowflake

Snowflake recommends you create a new user, role, and warehouse when you integrate a third-party tool like Pipedream. This way, you can control permissions via the user / role, and separate Pipedream compute and costs with the warehouse. You can do this directly in the Snowflake UI.

We recommend you create a read-only account if you only need to query Snowflake. If you need to insert data into Snowflake, add permissions on the appropriate objects after you create your user.

2. Enter those details in Pipedream

Visit https://pipedream.com/accounts. Click the button to Connect an App. Enter the required Snowflake account data.

You'll only need to connect your account once in Pipedream. You can connect this account to multiple workflows to run queries against Snowflake, insert data, and more.

3. Build your first workflow

Visit https://pipedream.com/new to build your first workflow. Pipedream workflows let you connect Snowflake with 1,000+ other apps. You can trigger workflows on Snowflake queries, sending results to Slack, Google Sheets, or any app that exposes an API. Or you can accept data from another app, transform it with Python, Node.js, Go or Bash code, and insert it into Snowflake.

Learn more at Pipedream University.

Trigger Code#

import common from "../common.mjs";

export default {
  ...common,
  props: {
    ...common.props,
    timer: {
      description: "Watch for failed tasks on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: 15 * 60,
      },
    },
    database: {
      propDefinition: [
        common.props.snowflake,
        "database",
      ],
    },
    schemas: {
      propDefinition: [
        common.props.snowflake,
        "schema",
        (configuredProps) => ({
          database: configuredProps.database,
        }),
      ],
      type: "string[]",
    },
    taskName: {
      type: "string",
      label: "Task Name",
      description: "The name of the task to watch for failures. It allows you to use Regex to match multiple tasks.",
      optional: true,
    },
  },
  type: "source",
  key: "snowflake-failed-task-in-schema",
  // eslint-disable-next-line
  name: "Failed Task in Schema",
  description: "Emit new events when a task fails in a database schema",
  version: "0.1.2",
  async run() {
    await this.emitFailedTasks({
      database: this.database,
      schemas: this.schemas,
      taskName: this.taskName,
    });
  },
};

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
Snowflake	`snowflake`	`app`	This component uses the Snowflake app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	Watch for failed tasks on this schedule
Database	`database`	`string`	Select a value from the drop down menu.
Schema	`schemas`	`string[]`	Select a value from the drop down menu.
Task Name	`taskName`	`string`	The name of the task to watch for failures. It allows you to use Regex to match multiple tasks.

Trigger Authentication#

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

We recommend you create a read-only account if you only need to query Snowflake. If you need to insert data into Snowflake, add permissions on the appropriate objects after you create your user.

About Snowflake#

A data warehouse built for the cloud

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.0.1

Key:boldsign-send-document-template

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";
import boldsign from "../../boldsign.app.mjs";
import { DOCUMENT_DOWNLOAD_OPTIONS } from "../../common/constants.mjs";
import {
  checkTmp,
  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.0.1",
  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: "Files",
      description: "A list of paths to files in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp).",
      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 filePath = fs.readFileSync(checkTmp(file), "base64");
          files.push(`data:application/${file.substr(file.length - 3)};base64,${filePath}`);
        }
      }

      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.
Files	`files`	`string[]`	A list of paths to files in the `/tmp` directory. See the documentation on working with files.
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