Search Content with Box API on Daily schedule from Schedule API

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

Trigger workflow on

Daily schedule from the Schedule API

Next, do this

Search Content with the Box API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule 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 Daily schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Search Content action
1. Connect your Box account
2. Optional- Select a Type
3. Optional- Configure Query
4. Optional- Configure Metadata Filters
5. Optional- Configure Fields
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#

Daily schedule on Schedule

Description:Trigger your workflow every day.

Version:0.0.1

Key:schedule-daily

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: "Daily schedule",
  version: "0.0.1",
  key: "schedule-daily",
  type: "source",
  description: "Trigger your workflow every day.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 11 * * *",
      },
    },
  },
};

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#

Search Content on Box

Description:Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. [See the documentation](https://developer.box.com/reference/get-search/).

Version:0.0.3

Key:box-search-content

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 app from "../../box.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import utils from "../../common/utils.mjs";

export default {
  name: "Search Content",
  description: "Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. [See the documentation](https://developer.box.com/reference/get-search/).",
  key: "box-search-content",
  version: "0.0.3",
  type: "action",
  props: {
    app,
    searchType: {
      propDefinition: [
        app,
        "searchType",
      ],
    },
    query: {
      propDefinition: [
        app,
        "query",
      ],
    },
    mdfilters: {
      propDefinition: [
        app,
        "mdfilters",
      ],
    },
    fields: {
      propDefinition: [
        app,
        "fields",
      ],
    },
  },
  async run({ $ }) {
    const results = [];
    if (!this.query && !this.mdfilters) {
      throw new ConfigurationError("At least one of `Query` and `Metadata Filters` props is needed.");
    }
    const resourcesStream = await utils.getResourcesStream({
      resourceFn: this.app.searchContent,
      resourceFnArgs: {
        $,
        params: {
          query: this.query,
          mdfilters: this.mdfilters,
          type: this.searchType,
          fields: this.fields,
        },
      },
    });
    for await (const resource of resourcesStream) {
      results.push(resource);
    }
    // eslint-disable-next-line multiline-ternary
    $.export("$summary", results.length ? `Successfully fetched ${results.length} search result${results.length === 1 ? "" : "s"}.` : "No search results.");
    return results;
  },
};

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.
Type	`searchType`	`string`	Select a value from the drop down menu:`{ "label": "Files", "value": "file" }{ "label": "Folders", "value": "folder" }{ "label": "Web Links", "value": "web_link" }`
Query	`query`	`string`	The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types. Please see the docs
Metadata Filters	`mdfilters`	`string`	A list of metadata templates to filter the search results by. e.g. `[{"scope":"enterprise","templateKey":"contract","filters":{"category":"online"}}]`. Please see the docs
Fields	`fields`	`string[]`	A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response, e.g. `id,type,name`

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: