Create Heading with Papyrs API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

Create Heading with the Papyrs 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 Papyrs 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 Create Heading action
1. Connect your Papyrs account
2. Optional- Configure Subsite
3. Select a Page
4. Configure Value
5. Optional- Select a Format
6. Optional- Select a Style Class
7. Optional- Select a Heading
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#

Create Heading on Papyrs

Description:Create Heading. [See the docs here](https://about.papyrs.com/@docs/API#Create-Text-box/Heading)

Version:0.0.1

Key:papyrs-create-heading

View on GitHub

Papyrs Overview#

The Papyrs API facilitates the creation and manipulation of rich text documents in your Papyrs intranet. With it, you can automate the handling of text-documents, forms, and pages within your organization's Papyrs account. When combined with Pipedream's capacity to connect to various APIs, the Papyrs API can be a powerful tool for document-driven workflow automation. You can trigger actions in Papyrs based on events from other apps, process Papyrs data for insights, or synchronize Papyrs content with external systems, databases, or file storage solutions.

Action Code#

import app from "../../papyrs.app.mjs";
import options from "../../common/enums.mjs";

export default {
  name: "Create Heading",
  description: "Create Heading. [See the docs here](https://about.papyrs.com/@docs/API#Create-Text-box/Heading)",
  key: "papyrs-create-heading",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    subsite: {
      propDefinition: [
        app,
        "subsite",
      ],
    },
    page: {
      propDefinition: [
        app,
        "page",
      ],
    },
    value: {
      propDefinition: [
        app,
        "value",
      ],
    },
    format: {
      propDefinition: [
        app,
        "format",
      ],
    },
    styleClass: {
      type: "string",
      label: "Style Class",
      description: "The style class of the heading.",
      options: options.CREATE_HEADING_STYLE_CLASS,
      optional: true,
    },
    heading: {
      type: "string",
      label: "Heading",
      description: "The size of the heading. `h0` is largest, `h4` is smallest.",
      options: options.CREATE_HEADING_HEADING,
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      widget: {
        val: this.value,
        format: this.format,
        styleclass: this.styleClass,
        heading: this.heading,
      },
    };
    const res = await this.app.createHeading(
      data,
      this.page,
      this.subsite,
      $,
    );
    $.export("$summary", "Heading successfully created");
    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
Papyrs	`app`	`app`	This component uses the Papyrs app.
Subsite	`subsite`	`string`	The subsite to use for this action. Use `home` for the default subsite.
Page	`page`	`string`	Select a value from the drop down menu.
Value	`value`	`string`	The value of the widget.
Format	`format`	`string`	Select a value from the drop down menu:`{ "value": "html", "label": "html — The value is HTML and is used unescaped (but sanitized to remove certain tags)." }{ "value": "text", "label": "text — The value is Text, any HTML tags are escaped, and line breaks are converted." }`
Style Class	`styleClass`	`string`	Select a value from the drop down menu:`lineemphasisbarsquoteboxquote`
Heading	`heading`	`string`	Select a value from the drop down menu:`h0h1h2h3h4`

Action Authentication#

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

To get your API Token, go to Site Settings > Integrations & SSO > API to request API access to your account.

Once API support is enabled, Site Owners can go to Site Settings > Integrations & SSO and click Generate Token to create a new unique API token for users.
You can get your Site Name by looking at the URL on your Papyrs dashboard -- it has the structure, https://{site_name}.papyrs.com/@home/Getting-Started.