Create Distributable Form and Generate Link with pdfFiller API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Distributable Form and Generate Link with the pdfFiller 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 pdfFiller action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Distributable Form and Generate Link action
1. Connect your pdfFiller account
2. Select a Document ID
3. Select a Access
4. Select a Status
5. Configure Name Required
6. Configure Email Required
7. Configure Enforce Required Fields
8. Configure Allow Downloads
9. Optional- Configure Redirect URL
10. Optional- Configure Custom Message
11. Optional- Configure Notification Emails
12. Optional- Configure Additional Documents
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

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: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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 Distributable Form and Generate Link on pdfFiller

Description:Transforms a document into a fillable form and generates a shareable link for the form. [See the documentation](https://docs.pdffiller.com/docs/pdffiller/9d3a06696db96-create-fillable-document-converts-a-downloaded-document-to-a-link-to-fill-form)

Version:0.0.2

Key:pdffiller-create-distributable-form-generate-link

View on GitHub

Action Code#

import {
  ACCESS_OPTIONS, STATUS_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import pdffiller from "../../pdffiller.app.mjs";

export default {
  key: "pdffiller-create-distributable-form-generate-link",
  name: "Create Distributable Form and Generate Link",
  description: "Transforms a document into a fillable form and generates a shareable link for the form. [See the documentation](https://docs.pdffiller.com/docs/pdffiller/9d3a06696db96-create-fillable-document-converts-a-downloaded-document-to-a-link-to-fill-form)",
  version: "0.0.2",
  type: "action",
  props: {
    pdffiller,
    documentId: {
      propDefinition: [
        pdffiller,
        "documentId",
      ],
    },
    access: {
      type: "string",
      label: "Access",
      description: "Access level for the fill request document.",
      options: ACCESS_OPTIONS,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Document access permission.",
      options: STATUS_OPTIONS,
    },
    nameRequired: {
      type: "boolean",
      label: "Name Required",
      description: "Name required",
      default: false,
    },
    emailRequired: {
      type: "boolean",
      label: "Email Required",
      description: "Email required",
      default: false,
    },
    enforceRequiredFields: {
      type: "boolean",
      label: "Enforce Required Fields",
      description: "Prevent closing document before filling all fields.",
      default: false,
    },
    allowDownloads: {
      type: "boolean",
      label: "Allow Downloads",
      description: "Allow to download",
      default: false,
    },
    redirectUrl: {
      type: "string",
      label: "Redirect URL",
      description: "Redirect to URL after complete.",
      optional: true,
    },
    customMessage: {
      type: "string",
      label: "Custom Message",
      description: "LinkToFill custom message.",
      optional: true,
    },
    notificationEmails: {
      type: "string[]",
      label: "Notification Emails",
      description: "LinkToFill notification emails.",
      optional: true,
    },
    additionalDocuments: {
      type: "string[]",
      label: "Additional Documents",
      description: "Additional documents required after filling the document. Max count 5.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.pdffiller.createFillableDocument({
      $,
      data: {
        document_id: this.documentId,
        access: this.access,
        status: this.status,
        name_required: this.nameRequired,
        email_required: this.emailRequired,
        enforce_required_fields: this.enforceRequiredFields,
        allow_downloads: this.allowDownloads,
        redirect_url: this.redirectUrl,
        notification_emails: parseObject(this.notificationEmails)?.map((email) => ({
          email,
        })),
        additional_documents: this.additionalDocuments,
        custom_message: this.customMessage,
      },
    });

    $.export("$summary", `Successfully created a fillable form and generated a shareable link for document ID ${this.fillableFormId}`);
    return response;
  },
};

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
pdfFiller	`pdffiller`	`app`	This component uses the pdfFiller app.
Document ID	`documentId`	`string`	Select a value from the drop down menu.
Access	`access`	`string`	Select a value from the drop down menu:`{ "label": "Full - read\|write\|sign.", "value": "full" }{ "label": "Signature - read\|sign.", "value": "signature" }`
Status	`status`	`string`	Select a value from the drop down menu:`publicprivate`
Name Required	`nameRequired`	`boolean`	Name required
Email Required	`emailRequired`	`boolean`	Email required
Enforce Required Fields	`enforceRequiredFields`	`boolean`	Prevent closing document before filling all fields.
Allow Downloads	`allowDownloads`	`boolean`	Allow to download
Redirect URL	`redirectUrl`	`string`	Redirect to URL after complete.
Custom Message	`customMessage`	`string`	LinkToFill custom message.
Notification Emails	`notificationEmails`	`string[]`	LinkToFill notification emails.
Additional Documents	`additionalDocuments`	`string[]`	Additional documents required after filling the document. Max count 5.

Action Authentication#

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

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