Send Document with Papersign API on New Job (Instant) from Cloud Convert API

Pipedream makes it easy to connect APIs for Papersign, Cloud Convert and 2,800+ other apps remarkably fast.

Trigger workflow on

New Job (Instant) from the Cloud Convert API

Next, do this

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

Select this integration
Configure the New Job (Instant) trigger
1. Connect your Cloud Convert account
Configure the Send Document action
1. Connect your Papersign account
2. Select a Document ID
3. Optional- Configure Expiration
4. Optional- Configure Invite Message
5. Optional- Configure From User Email
6. Optional- Configure Document Recipient Emails
7. Optional- Configure Automatic Reminder - First After Days
8. Optional- Configure Automatic Reminder - Follow Up Every Days
9. Optional- Configure Signers
10. Optional- Configure Variables
11. Optional- Configure Copy
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 Job (Instant) on Cloud Convert

Description:Emit new event when a new job has been created. [See the documentation](https://cloudconvert.com/api/v2/webhooks#webhooks-events)

Version:0.0.1

Key:cloud_convert-new-job-instant

View on GitHub

Cloud Convert Overview#

The Cloud Convert API offers a robust solution for file conversion, supporting a vast array of file formats. With Pipedream, you can harness this versatility to create automated workflows that trigger file conversions, process the resulting files, and integrate with other services. By combining Cloud Convert with Pipedream's connectivity to hundreds of apps, you can craft custom automation that saves time and removes the friction from multi-format file management tasks.

Trigger Code#

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

export default {
  ...common,
  key: "cloud_convert-new-job-instant",
  name: "New Job (Instant)",
  description: "Emit new event when a new job has been created. [See the documentation](https://cloudconvert.com/api/v2/webhooks#webhooks-events)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvents() {
      return [
        events.JOB_CREATED,
      ];
    },
    generateMeta(resource) {
      const { job } = resource;
      const ts = Date.parse(job.created_at);
      return {
        id: job.id,
        summary: `New Job: ${job.id}`,
        ts,
      };
    },
  },
};

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
Cloud Convert	`app`	`app`	This component uses the Cloud Convert 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.

Trigger Authentication#

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

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

user.readuser.writetask.readtask.writewebhook.readwebhook.write

About Cloud Convert#

File converter service

Action#

Send Document on Papersign

Description:Dispatches a document to a specified recipient. [See the documentation](https://paperform.readme.io/reference/papersignsenddocument)

Version:0.0.1

Key:papersign-send-document

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import papersign from "../../papersign.app.mjs";

export default {
  key: "papersign-send-document",
  name: "Send Document",
  description: "Dispatches a document to a specified recipient. [See the documentation](https://paperform.readme.io/reference/papersignsenddocument)",
  version: "0.0.1",
  type: "action",
  props: {
    papersign,
    documentId: {
      propDefinition: [
        papersign,
        "documentId",
      ],
    },
    expiration: {
      type: "string",
      label: "Expiration",
      description: "The expiration date of the document. Must be at least 30 minutes in the future. **Format: YYYY-MM-DDTHH:MM:SS.SSSZ**",
      optional: true,
    },
    inviteMessage: {
      type: "string",
      label: "Invite Message",
      description: "The message to include in the invitation email, up to 1000 characters.",
      optional: true,
    },
    fromUserEmail: {
      type: "string",
      label: "From User Email",
      description: "The email address of a User on your team's account to send the document from.",
      optional: true,
    },
    documentRecipientEmails: {
      type: "string[]",
      label: "Document Recipient Emails",
      description: "An array of recipient emails for the document.",
      optional: true,
    },
    firstAfterDays: {
      type: "integer",
      label: "Automatic Reminder - First After Days",
      description: "The number of days after the document is sent to send the reminder.",
      optional: true,
    },
    followUpEveryDays: {
      type: "integer",
      label: "Automatic Reminder - Follow Up Every Days",
      description: "The number of days to wait between reminders.",
      optional: true,
    },
    signers: {
      type: "string[]",
      label: "Signers",
      description: "An array of objects of signers. **Object format: {\"key\": \"123\",\"name\": \"Jack Smith\",\"email\": \"signer@example.com\",\"phone\": \"123 456 7899\",\"job_title\": \"Account Manager\",\"company\": \"Explosive Startup\",\"custom_attributes\": [{\"key\": \"Relationship\",\"label\": \"Relationship to the company\",\"value\": \"CEO\"}]}**",
      optional: true,
    },
    variables: {
      type: "object",
      label: "Variables",
      description: "The key: value of the document variables.",
      optional: true,
    },
    copy: {
      type: "boolean",
      label: "Copy",
      description: "Whether to copy before sending.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (
      (this.firstAfterDays && !this.followUpEveryDays) ||
      (!this.firstAfterDays && this.followUpEveryDays)
    ) {
      throw new ConfigurationError("You must fill in the fields 'First After Days' and 'Follow Up Every Days' or none of them");
    }

    const automaticReminders = {};
    if (this.firstAfterDays) {
      automaticReminders.first_after_days = this.firstAfterDays;
      automaticReminders.follow_up_every_days = this.followUpEveryDays;
    }

    const variables = [];
    if (this.variables) {
      for (const key of Object.keys(parseObject(this.variables))) {
        variables.push({
          key,
          value: this.variables[key],
        });
      }
    }

    const response = await this.papersign.sendDocument({
      $,
      documentId: this.documentId,
      data: {
        expiration: this.expiration,
        inviteMessage: this.inviteMessage,
        fromUserEmail: this.fromUserEmail,
        documentRecipientEmails: parseObject(this.documentRecipientEmails),
        automaticReminders,
        signers: parseObject(this.signers),
        variables,
        copy: this.copy,
      },
    });
    $.export("$summary", `Document sent successfully with ID ${this.documentId}`);
    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
Papersign	`papersign`	`app`	This component uses the Papersign app.
Document ID	`documentId`	`string`	Select a value from the drop down menu.
Expiration	`expiration`	`string`	The expiration date of the document. Must be at least 30 minutes in the future. Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Invite Message	`inviteMessage`	`string`	The message to include in the invitation email, up to 1000 characters.
From User Email	`fromUserEmail`	`string`	The email address of a User on your team's account to send the document from.
Document Recipient Emails	`documentRecipientEmails`	`string[]`	An array of recipient emails for the document.
Automatic Reminder - First After Days	`firstAfterDays`	`integer`	The number of days after the document is sent to send the reminder.
Automatic Reminder - Follow Up Every Days	`followUpEveryDays`	`integer`	The number of days to wait between reminders.
Signers	`signers`	`string[]`	An array of objects of signers. Object format: {"key": "123","name": "Jack Smith","email": "signer@example.com","phone": "123 456 7899","job_title": "Account Manager","company": "Explosive Startup","custom_attributes": [{"key": "Relationship","label": "Relationship to the company","value": "CEO"}]}
Variables	`variables`	`object`	The key: value of the document variables.
Copy	`copy`	`boolean`	Whether to copy before sending.

Send Document with Papersign API on New Job (Instant) from Cloud Convert API

Pipedream makes it easy to connect APIs for Papersign, Cloud Convert and 2,800+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,800+apps by most popular

1
-
24
of
2,800+
apps by most popular