Send Sign Request with Stiply API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Send Sign Request action
1. Connect your Stiply account
2. Configure Title
3. Configure File URLs
4. Configure Signers
5. Optional- Configure Subject
6. Optional- Configure Message
7. Optional- Select a Signing Sequence Type
8. Optional- Configure Term
9. Optional- Configure External Key
10. Optional- Configure Comment
11. Optional- Configure Callback URL
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#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

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: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

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#

Send Sign Request on Stiply

Description:Send a sign request to a recipient. [See the documentation](https://app.stiply.nl/api-documentation/v2#tag/sign-requests/operation/SendSignRequest)

Version:0.0.2

Key:stiply-send-sign-request

View on GitHub

Action Code#

import stiply from "../../stiply.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "stiply-send-sign-request",
  name: "Send Sign Request",
  description: "Send a sign request to a recipient. [See the documentation](https://app.stiply.nl/api-documentation/v2#tag/sign-requests/operation/SendSignRequest)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    stiply,
    title: {
      type: "string",
      label: "Title",
      description: "The title of the sign request",
    },
    fileUrls: {
      type: "string[]",
      label: "File URLs",
      description: "The URLs of the files to be signed",
    },
    signers: {
      type: "string[]",
      label: "Signers",
      description: "An array of objects representing the signers of the sign request. Example: `[{ \"email\": \"test@example.com\", \"name\": \"John Doe\" }]`. [See the documentation](https://app.stiply.nl/api-documentation/v2#tag/sign-requests/operation/SendSignRequest) for more information about signer properties.",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject of the e-mail to the signers",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "The message to the signers. The message can have some basic HTML tags.",
      optional: true,
    },
    signingSequenceType: {
      type: "string",
      label: "Signing Sequence Type",
      description: "Choose if all signers can sign in parallel or sequential",
      options: [
        "sequential",
        "parallel",
      ],
      optional: true,
    },
    term: {
      type: "string",
      label: "Term",
      description: "2 digit code representing the sign term (1d = one day, 2w = two weeks, 3m = three months). When omitted, the account's configured default term will be used.",
      optional: true,
    },
    externalKey: {
      type: "string",
      label: "External Key",
      description: "A key for your internal use so you don't have to save the Stiply sign request key in your local database. However, your external key has to be unique.",
      optional: true,
    },
    comment: {
      type: "string",
      label: "Comment",
      description: "A comment for internal use",
      optional: true,
    },
    callbackUrl: {
      type: "string",
      label: "Callback URL",
      description: "An URL to be called by Stiply when the last signer has signed the document. Please note that key={sign_request_key},external_key={external_key} and sign_request_id={sign_request_id} shall be added to the call back url querystring. The URL will be called using a GET request. When the callback responses with an error status code, the callback is retried 12 times using an exponential backoff algoritm.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.stiply.sendSignRequest({
      $,
      data: {
        title: this.title,
        subject: this.subject,
        message: this.message,
        signing_sequence_type: this.signingSequenceType,
        term: this.term,
        external_key: this.externalKey,
        comment: this.comment,
        call_back_url: this.callbackUrl,
        file_urls: this.fileUrls,
        signers: parseObject(this.signers),
      },
    });
    $.export("$summary", `Sign request with ID; ${response.data.id} sent successfully`);
    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
Stiply	`stiply`	`app`	This component uses the Stiply app.
Title	`title`	`string`	The title of the sign request
File URLs	`fileUrls`	`string[]`	The URLs of the files to be signed
Signers	`signers`	`string[]`	An array of objects representing the signers of the sign request. Example: `[{ "email": "test@example.com", "name": "John Doe" }]`. See the documentation for more information about signer properties.
Subject	`subject`	`string`	The subject of the e-mail to the signers
Message	`message`	`string`	The message to the signers. The message can have some basic HTML tags.
Signing Sequence Type	`signingSequenceType`	`string`	Select a value from the drop down menu:`sequentialparallel`
Term	`term`	`string`	2 digit code representing the sign term (1d = one day, 2w = two weeks, 3m = three months). When omitted, the account's configured default term will be used.
External Key	`externalKey`	`string`	A key for your internal use so you don't have to save the Stiply sign request key in your local database. However, your external key has to be unique.
Comment	`comment`	`string`	A comment for internal use
Callback URL	`callbackUrl`	`string`	An URL to be called by Stiply when the last signer has signed the document. Please note that key={sign_request_key},external_key={external_key} and sign_request_id={sign_request_id} shall be added to the call back url querystring. The URL will be called using a GET request. When the callback responses with an error status code, the callback is retried 12 times using an exponential backoff algoritm.

Action Authentication#

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

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

SignRequest.ReadWrite