Create Space with Workast API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Space with the Workast 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 Workast 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 Space action
1. Connect your Workast account
2. Configure Name
3. Optional- Configure Description
4. Optional- Select one or more Participants Ids
5. Optional- Select a Type
6. Optional- Select a Privacy
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 Space on Workast

Description:Creates a space. [See docs here](https://developers.workast.com/#/method/createSpace)

Version:0.0.1

Key:workast-create-space

View on GitHub

Workast Overview#

The Workast API enables the automation of task management in your projects, allowing the creation, update, and tracking of tasks without leaving the context of your current workflow. With the Workast API on Pipedream, you can tap into this functionality to build seamless integrations and automate repetitive actions, such as syncing tasks across multiple platforms, generating reports, or triggering reminders and notifications based on specific task events.

Action Code#

import { defineAction } from "@pipedream/types";
import workast from "../../app/workast.app.mjs";
import constants from "../common/constants.mjs";
export default defineAction({
    name: "Create Space",
    version: "0.0.1",
    key: "workast-create-space",
    description: "Creates a space. [See docs here](https://developers.workast.com/#/method/createSpace)",
    type: "action",
    props: {
        workast,
        name: {
            label: "Name",
            description: "The space name",
            type: "string",
        },
        description: {
            label: "Description",
            description: "The space description",
            type: "string",
            optional: true,
        },
        userIds: {
            label: "Participants Ids",
            description: "The user ID to assigne to the task",
            type: "string[]",
            propDefinition: [
                workast,
                "userId",
            ],
            optional: true,
        },
        type: {
            label: "Type",
            description: "The type of the space",
            type: "string",
            options: constants.SPACE_TYPES,
            optional: true,
        },
        privacy: {
            label: "Privacy",
            description: "The privacy of the space",
            type: "string",
            options: constants.SPACE_PRIVACIES,
            optional: true,
        },
    },
    async run({ $ }) {
        const participantsParsed = typeof this.userIds === "string"
            ? JSON.parse(this.userIds)
            : this.userIds;
        const response = await this.workast.createSpace({
            $,
            data: {
                name: this.name,
                description: this.description,
                participants: participantsParsed ?? [],
                type: this.type,
                privacy: this.privacy,
            },
        });
        if (response) {
            $.export("$summary", `Successfully created space with id ${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
Workast	`workast`	`app`	This component uses the Workast app.
Name	`name`	`string`	The space name
Description	`description`	`string`	The space description
Participants Ids	`userIds`	`string[]`	Select a value from the drop down menu.
Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Direct", "value": "direct" }{ "label": "Group", "value": "group" }{ "label": "Template", "value": "template" }`
Privacy	`privacy`	`string`	Select a value from the drop down menu:`{ "label": "Private", "value": "private" }{ "label": "Team", "value": "team" }`

Action Authentication#

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

To retrieve your API key:

Navigate to your Workast account and sign in
In Chrome you need to open the Developers tools (View -> Developer -> Developer tools)
Go to the Application tab
Navigate to cookies and you will find a cookie called token
Remember to URL decode the token before you use it with a tool like https://www.urldecoder.org/