Create Box Sign Request with Box API on New Download Counts from npm API

Pipedream makes it easy to connect APIs for Box, npm and 2,800+ other apps remarkably fast.

Trigger workflow on

New Download Counts from the npm API

Next, do this

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

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Create Box Sign Request action
1. Connect your Box account
2. Configure Signers
3. Optional- Configure Request Name
4. Optional- Select a Parent Folder
5. Optional- Configure Email Subject
6. Optional- Configure Email Message
7. Optional- Configure Redirect URL
8. Optional- Configure Declined Redirect URL
9. Optional- Configure Additional Options
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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

import app from "../../npm.app.mjs";

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Create Box Sign Request on Box

Description:Creates a signature request. This involves preparing a document for signing and sending the signature request to signers. [See the documentation](https://developer.box.com/reference/post-sign-requests/).

Version:0.0.1

Key:box-create-sign-request

View on GitHub

Box Overview#

The Box API offers a playground for enhancing content management and collaboration within your cloud storage. With Pipedream, you can orchestrate Box's functionality to automate document handling, streamline approval flows, sync files across apps, and trigger actions based on file events. Think of Pipedream as the glue that allows you to connect Box with your tech stack, triggering workflows with new file uploads, comments, or when sharing settings change, to enhance productivity and minimize manual labor.

Action Code#

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

export default {
  name: "Create Box Sign Request",
  description: "Creates a signature request. This involves preparing a document for signing and sending the signature request to signers. [See the documentation](https://developer.box.com/reference/post-sign-requests/).",
  key: "box-create-sign-request",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    signers: {
      type: "string[]",
      label: "Signers",
      description: "Array of signers for the signature request. Each signer should be a JSON object with at least an email property. [See the documentation](https://developer.box.com/reference/post-sign-requests/#param-signers) for more information. Example: `{\"email\": \"signer@example.com\", \"role\": \"signer\"}`",
    },
    name: {
      type: "string",
      label: "Request Name",
      description: "Name of the signature request",
      optional: true,
    },
    parentFolder: {
      propDefinition: [
        app,
        "parentId",
      ],
      label: "Parent Folder",
      description: "The destination folder to place final, signed document and signing log. Uses root folder (0) if not specified",
      optional: true,
    },
    emailSubject: {
      type: "string",
      label: "Email Subject",
      description: "Subject of sign request email. If not provided, a default subject will be used",
      optional: true,
    },
    emailMessage: {
      type: "string",
      label: "Email Message",
      description: "Message to include in sign request email. If not provided, a default message will be used",
      optional: true,
    },
    redirectUrl: {
      type: "string",
      label: "Redirect URL",
      description: "The URI that a signer will be redirected to after signing a document",
      optional: true,
    },
    declinedRedirectUrl: {
      type: "string",
      label: "Declined Redirect URL",
      description: "The URI that a signer will be redirected to after declining to sign a document",
      optional: true,
    },
    additionalOptions: {
      type: "object",
      label: "Additional Options",
      description: "Additional parameters to send in the request. See the [documentation](https://developer.box.com/reference/post-sign-requests/) for all available parameters. Values will be parsed as JSON where applicable",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      signers,
      name,
      parentFolder,
      emailSubject,
      emailMessage,
      redirectUrl,
      declinedRedirectUrl,
      additionalOptions,
    } = this;

    const parsedSigners = signers.map((signer) => {
      try {
        return typeof signer === "string"
          ? JSON.parse(signer)
          : signer;
      } catch (error) {
        throw new ConfigurationError(`Error parsing signer as JSON: ${error}`);
      }
    });

    const data = {
      signers: parsedSigners,
      name,
      email_subject: emailSubject,
      email_message: emailMessage,
      redirect_url: redirectUrl,
      declined_redirect_url: declinedRedirectUrl,
      ...(additionalOptions
        ? utils.parseObjectEntries(additionalOptions)
        : {}),
    };

    if (parentFolder) {
      data.parent_folder = {
        id: parentFolder,
        type: "folder",
      };
    }

    const response = await this.app.createSignRequest({
      $,
      data,
    });

    $.export("$summary", `Successfully created Box sign request (ID: ${response.id})`);
    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
Box	`app`	`app`	This component uses the Box app.
Signers	`signers`	`string[]`	Array of signers for the signature request. Each signer should be a JSON object with at least an email property. See the documentation for more information. Example: `{"email": "signer@example.com", "role": "signer"}`
Request Name	`name`	`string`	Name of the signature request
Parent Folder	`parentFolder`	`string`	Select a value from the drop down menu.
Email Subject	`emailSubject`	`string`	Subject of sign request email. If not provided, a default subject will be used
Email Message	`emailMessage`	`string`	Message to include in sign request email. If not provided, a default message will be used
Redirect URL	`redirectUrl`	`string`	The URI that a signer will be redirected to after signing a document
Declined Redirect URL	`declinedRedirectUrl`	`string`	The URI that a signer will be redirected to after declining to sign a document
Additional Options	`additionalOptions`	`object`	Additional parameters to send in the request. See the documentation for all available parameters. Values will be parsed as JSON where applicable

Action Authentication#

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

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

About Box#

Platform for secure content management, workflow, and collaboration

More Ways to Connect Box + npm#

Other Popular Integrations#

Search Content with Box API on npm Download Counts from npm API

npm + Box

Create Box Sign Request with Box API on New Download Counts from npm API

Pipedream makes it easy to connect APIs for Box, npm 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