Upsert Document with Dust API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Upsert Document action
1. Connect your Dust account
2. Select a Folder ID
3. Configure Document Id
4. Configure Content
5. Optional- Configure Light Document Output
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#

Weekly schedule on Schedule

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

Version:0.0.1

Key:schedule-weekly

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: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week 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#

Upsert Document on Dust

Description:Upsert a document to a chosen Dust data source. [See the documentation](https://docs.dust.tt/reference/post_api-v1-w-wid-data-sources-name-documents-documentid)

Version:0.0.1

Key:dust-upsert-document

View on GitHub

Action Code#

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

export default {
  key: "dust-upsert-document",
  name: "Upsert Document",
  description: "Upsert a document to a chosen Dust data source. [See the documentation](https://docs.dust.tt/reference/post_api-v1-w-wid-data-sources-name-documents-documentid)",
  version: "0.0.1",
  type: "action",
  props: {
    dust,
    dataSourceId: {
      propDefinition: [
        dust,
        "dataSourceId",
      ],
    },
    documentId: {
      type: "string",
      label: "Document Id",
      description: "An Id for the new document",
    },
    content: {
      type: "string",
      label: "Content",
      description: "The text content of the document to upsert.",
    },
    lightDocumentOutput: {
      type: "boolean",
      label: "Light Document Output",
      description: "If true, a lightweight version of the document will be returned in the response (excluding the text, chunks and vectors). Defaults to false.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.dust.upsertDocument({
      $,
      dataSourceId: this.dataSourceId,
      documentId: this.documentId,
      data: {
        text: this.content,
        light_document_output: this.lightDocumentOutput,
      },
    });

    $.export("$summary", "Successfully uploaded document");
    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
Dust	`dust`	`app`	This component uses the Dust app.
Folder ID	`dataSourceId`	`string`	Select a value from the drop down menu.
Document Id	`documentId`	`string`	An Id for the new document
Content	`content`	`string`	The text content of the document to upsert.
Light Document Output	`lightDocumentOutput`	`boolean`	If true, a lightweight version of the document will be returned in the response (excluding the text, chunks and vectors). Defaults to false.