Search files and folders with Dropbox API on New Highlights from Readwise API

Pipedream makes it easy to connect APIs for Dropbox, Readwise and 2,400+ other apps remarkably fast.

Trigger workflow on

New Highlights from the Readwise API

Next, do this

Search files and folders with the Dropbox 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 Readwise trigger and Dropbox action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Highlights trigger
1. Connect your Readwise account
2. Configure Polling interval
3. Optional- Select a Book Id
Configure the Search files and folders action
1. Connect your Dropbox account
2. Configure Query
3. Select a Path
4. Optional- Select a Order By
5. Optional- Select a File Status
6. Optional- Configure Filename Only
7. Optional- Select one or more File Categories
8. Optional- Configure File Extensions
9. Optional- Configure Include Highlights
10. Optional- Configure Limit
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 Highlights on Readwise

Description:Emit new Highlight

Version:0.0.5

Key:readwise-new-highlights

View on GitHub

Readwise Overview#

The Readwise API allows you to access and manipulate your Readwise data, which includes highlights, notes, and books from your reading list. With this API, you can automate the retrieval of your reading highlights, synchronize them across various platforms, or trigger custom actions based on new highlights added. Pipedream, as a serverless integration and compute platform, enables you to create workflows that leverage the Readwise API to build powerful automations, connecting your reading insights to countless other apps and services to enrich productivity and data management.

Trigger Code#

import readwise from "../../readwise.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "readwise-new-highlights",
  name: "New Highlights",
  description: "Emit new Highlight",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    readwise,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Readwise API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    bookId: {
      propDefinition: [
        readwise,
        "bookId",
      ],
      optional: true,
    },
  },
  hooks: {
    async activate() {
      await this.processHighlighs({
        book_id: this.bookId,
        page_size: 25,
      });
    },
  },
  methods: {
    _getLastHighlightedAt() {
      return this.db.get("lastHighlightedAt");
    },
    _setLastHighlightedAt(lastHighlightedAt) {
      this.db.set("lastHighlightedAt", lastHighlightedAt);
    },
    async retrieveTicket(id) {
      return this.readwise.retrieveTicket({
        id,
      });
    },
    async processHighlighs(params) {
      const { results: events } = await this.readwise.listHighlights({
        params,
      });
      for (const event of events) {
        this.emitEvent(await this.readwise.getHighlight({
          highlightId: event.id,
        }));
      }
    },
    async processEvent() {
      const lastHighlightedAt = this._getLastHighlightedAt();
      await this.processHighlighs({
        book_id: this.bookId,
        highlighted_at__gt: lastHighlightedAt,
      });
    },
    emitEvent(event, lastHighlightedAt = null) {
      lastHighlightedAt = lastHighlightedAt || this._getLastHighlightedAt();

      if (!lastHighlightedAt || (new Date(event.highlighted_at) > new Date(lastHighlightedAt)))
        this._setLastHighlightedAt(event.highlighted_at);

      const ts = Date.parse(event.highlighted_at);
      this.$emit(event, {
        id: `${event.id}_${ts}`,
        ts,
        summary: `New highlight: ${event.id}`,
      });
    },
  },
  async run() {
    console.log("Raw received event:");
    return this.processEvent();
  },
};

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
Readwise	`readwise`	`app`	This component uses the Readwise app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Readwise API on this schedule
Book Id	`bookId`	`integer`	Select a value from the drop down menu.

Trigger Authentication#

Readwise uses API keys for authentication. When you connect your Readwise account, Pipedream securely stores the keys so you can easily authenticate to Readwise APIs in both code and no-code steps.

About Readwise#

Readwise makes it easy to revisit and learn from your ebook & article highlights.

Action#

Search files and folders on Dropbox

Description:Searches for files and folders by name. [See the documentation](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesSearchV2__anchor)

Version:0.0.10

Key:dropbox-search-files-folders

View on GitHub

Dropbox Overview#

The Dropbox API on Pipedream enables you to automate file and folder operations, streamlining workflows that involve storing, syncing, and sharing content. With this API, you can programmatically manage files, set up event-driven triggers based on changes within Dropbox, and leverage Pipedream's capabilities to connect with hundreds of other apps for extended automation scenarios. It's ideal for building custom file management solutions, archiving systems, or collaborative content workflows without writing extensive code.

Action Code#

import dropbox from "../../dropbox.app.mjs";
import isNil from "lodash/isNil.js";
import consts from "../../common/consts.mjs";

export default {
  name: "Search files and folders",
  description: "Searches for files and folders by name. [See the documentation](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesSearchV2__anchor)",
  key: "dropbox-search-files-folders",
  version: "0.0.10",
  type: "action",
  props: {
    dropbox,
    query: {
      propDefinition: [
        dropbox,
        "query",
      ],
    },
    path: {
      propDefinition: [
        dropbox,
        "path",
        () => ({
          filter: ({ metadata: { metadata: { [".tag"]: type } } }) => type === "folder",
        }),
      ],
      description: "Type the folder name to search for it in the user's Dropbox.",
    },
    orderBy: {
      type: "string",
      label: "Order By",
      description: "By default, results are sorted by relevance.",
      optional: true,
      options: consts.SEARCH_FILE_FOLDER_ORDER_BY_OPTIONS,
    },
    fileStatus: {
      type: "string",
      label: "File Status",
      description: "Restricts search to the given file status.",
      optional: true,
      options: consts.SEARCH_FILE_FOLDER_STATUS_OPTIONS,
    },
    filenameOnly: {
      type: "boolean",
      label: "Filename Only",
      description: "Restricts search to only match on filenames.",
      optional: true,
    },
    fileCategories: {
      type: "string[]",
      label: "File Categories",
      description: "Restricts search to only the file categories specified. Only supported for active file search.",
      optional: true,
      options: consts.FILES_CATEGORIES_OPTIONS,
    },
    fileExtensions: {
      type: "string[]",
      label: "File Extensions",
      description: "Restricts search to only the extensions specified. Only supported for active file search.",
      optional: true,
    },
    includeHighlights: {
      type: "boolean",
      label: "Include Highlights",
      description: "Whether to include highlight span from file title.",
      optional: true,
    },
    limit: {
      propDefinition: [
        dropbox,
        "limit",
      ],
    },
  },
  async run({ $ }) {
    const {
      query,
      includeHighlights,
      limit,
      path,
      orderBy,
      fileStatus,
      filenameOnly,
      fileExtensions,
      fileCategories,
    } = this;
    const res = await this.dropbox.searchFilesFolders({
      query,
      match_field_options: !isNil(includeHighlights)
        ? undefined
        : {
          include_highlights: includeHighlights,
        },
      options: {
        path: this.dropbox.getPath(path),
        order_by: orderBy
          ? {
            ".tag": orderBy,
          }
          : undefined,
        file_status: fileStatus
          ? {
            ".tag": fileStatus,
          }
          : undefined,
        filename_only: filenameOnly,
        file_extensions: fileExtensions,
        file_categories: fileCategories
          ? fileCategories.map((category) => ({
            ".tag": category,
          }))
          : undefined,
      },
    }, limit);
    $.export("$summary", "Files and folders successfully fetched");
    return res;
  },
};

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
Dropbox	`dropbox`	`app`	This component uses the Dropbox app.
Query	`query`	`string`	The string to search for. May match across multiple fields based on the request arguments.
Path	`path`	`string`	Select a value from the drop down menu.
Order By	`orderBy`	`string`	Select a value from the drop down menu:`relevancelast_modified_time`
File Status	`fileStatus`	`string`	Select a value from the drop down menu:`activedeleted`
Filename Only	`filenameOnly`	`boolean`	Restricts search to only match on filenames.
File Categories	`fileCategories`	`string[]`	Select a value from the drop down menu:`imagedocumentpdfspreadsheetpresentationaudiovideofolderpaperothersother`
File Extensions	`fileExtensions`	`string[]`	Restricts search to only the extensions specified. Only supported for active file search.
Include Highlights	`includeHighlights`	`boolean`	Whether to include highlight span from file title.
Limit	`limit`	`integer`	Specify a max amount of register to be fetched. Defaults to `100` if left blank.

Action Authentication#

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

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

About Dropbox#

Dropbox gives you secure access to all your files. Collaborate with friends, family, and coworkers from any device.

More Ways to Connect Dropbox + Readwise#

Other Popular Integrations#

Get Highlight Details with Readwise API on New or Modified File or Folder from Dropbox API

Dropbox + Readwise

Search files and folders with Dropbox API on New Highlights from Readwise API

Pipedream makes it easy to connect APIs for Dropbox, Readwise and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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