Create Room with ONLYOFFICE DocSpace API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for ONLYOFFICE DocSpace, Schedule and 2,200+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

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

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Room action
1. Connect your ONLYOFFICE DocSpace account
2. Configure Title
3. Select a Room Type
4. Optional- Configure Notify
5. Optional- Configure Sharing Message
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

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: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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 Room on ONLYOFFICE DocSpace

Description:Creates a new room. [See the documentation](https://api.onlyoffice.com/docspace/method/files/post/api/2.0/files/rooms)

Version:0.0.1

Key:onlyoffice_docspace-create-room

View on GitHub

Action Code#

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

export default {
  key: "onlyoffice_docspace-create-room",
  name: "Create Room",
  description: "Creates a new room. [See the documentation](https://api.onlyoffice.com/docspace/method/files/post/api/2.0/files/rooms)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    title: {
      type: "string",
      label: "Title",
      description: "The name of the room to be created.",
    },
    roomType: {
      type: "integer",
      label: "Room Type",
      description: "The type of the room.",
      options: [
        {
          label: "Editing Room",
          value: 2,
        },
        {
          label: "Custom Room",
          value: 5,
        },
        {
          label: "Public Room",
          value: 6,
        },
      ],
    },
    notify: {
      type: "boolean",
      label: "Notify",
      description: "Whether to notify the user about the room creation.",
      optional: true,
    },
    sharingMessage: {
      type: "string",
      label: "Sharing Message",
      description: "Message to send when notifying about the shared room",
      optional: true,
    },
  },
  methods: {
    createRoom(args = {}) {
      return this.app.post({
        path: "/files/rooms",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createRoom,
      title,
      roomType,
      notify,
      sharingMessage,
    } = this;

    const response = await createRoom({
      $,
      data: {
        Title: title,
        RoomType: roomType,
        Notify: notify,
        SharingMessage: sharingMessage,
      },
    });
    $.export("$summary", `Successfully created room with ID \`${response.response.id}\`.`);
    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
ONLYOFFICE DocSpace	`app`	`app`	This component uses the ONLYOFFICE DocSpace app.
Title	`title`	`string`	The name of the room to be created.
Room Type	`roomType`	`integer`	Select a value from the drop down menu:`{ "label": "Editing Room", "value": 2 }{ "label": "Custom Room", "value": 5 }{ "label": "Public Room", "value": 6 }`
Notify	`notify`	`boolean`	Whether to notify the user about the room creation.
Sharing Message	`sharingMessage`	`string`	Message to send when notifying about the shared room

Action Authentication#

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

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