Submit Spreadsheet with CSVbox API on Monthly Schedule from Schedule API

Pipedream makes it easy to connect APIs for CSVbox, Schedule and 3,000+ other apps remarkably fast.

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

Submit Spreadsheet with the CSVbox 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 CSVbox 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 Submit Spreadsheet action
1. Connect your CSVbox account
2. Configure File Path Or URL
3. Configure Sheet License Key
4. Optional- Configure User ID
5. Optional- Configure Has Headers
6. Optional- Configure syncDir
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#

Submit Spreadsheet on CSVbox

Description:Submit a spreadsheet file via public URL or local file path to CSVBox for processing. [See documentation](https://help.csvbox.io/advanced-installation/rest-file-api)

Version:0.0.1

Key:csvbox-submit-spreadsheet

View on GitHub

Action Code#

import FormData from "form-data";
import { getFileStream } from "@pipedream/platform";
import app from "../../csvbox.app.mjs";

export default {
  key: "csvbox-submit-spreadsheet",
  name: "Submit Spreadsheet",
  description: "Submit a spreadsheet file via public URL or local file path to CSVBox for processing. [See documentation](https://help.csvbox.io/advanced-installation/rest-file-api)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    file: {
      type: "string",
      label: "File Path Or URL",
      description: "Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/spreadsheet.csv`).",
    },
    sheetLicenseKey: {
      propDefinition: [
        app,
        "sheetLicenseKey",
      ],
    },
    userId: {
      propDefinition: [
        app,
        "userId",
      ],
    },
    hasHeaders: {
      propDefinition: [
        app,
        "hasHeaders",
      ],
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  annotations: {
    readOnlyHint: false,
    destructiveHint: false,
    openWorldHint: true,
  },
  methods: {
    booleanToNumber(value) {
      return value === true || value === "true" || value === "1" || value === 1
        ? 1
        : 0;
    },
  },
  async run({ $ }) {
    const {
      app,
      booleanToNumber,
      file,
      sheetLicenseKey,
      userId,
      hasHeaders,
    } = this;
    let data;

    const isUrl = file?.startsWith("http://") || file?.startsWith("https://");

    const otherFields = {
      ...(userId
        ? {
          user: {
            user_id: userId,
          },
        }
        : {}
      ),
      ...(hasHeaders
        ? {
          options: {
            has_header: booleanToNumber(hasHeaders),
          },
        }
        : {}
      ),
    };

    if (isUrl) {
      data = {
        import: {
          public_file_url: file,
          sheet_license_key: sheetLicenseKey,
          ...otherFields,
        },
      };

    } else {
      data = new FormData();
      data.append("file", await getFileStream(file));
      data.append("import", JSON.stringify({
        sheet_license_key: sheetLicenseKey,
        ...otherFields,
      }));
    }

    const response = await app.submitFile({
      $,
      headers: !isUrl
        ? {
          "Content-Type": "multipart/form-data",
        }
        : undefined,
      data,
    });

    $.export("$summary", "Successfully submitted spreadsheet");

    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
CSVbox	`app`	`app`	This component uses the CSVbox app.
File Path Or URL	`file`	`string`	Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/spreadsheet.csv`).
Sheet License Key	`sheetLicenseKey`	`string`	The unique identifier for your CSVBox sheet. You can find it in Sheets - Edit - Code Snippet - Sheet License Key.
User ID	`userId`	`string`	The unique identifier for the user. You can find it in the Dashboard - Edit - Code Snippet.
Has Headers	`hasHeaders`	`boolean`	Whether the spreadsheet has headers.
syncDir	`syncDir`	`dir`