Create New Task with Kanbanize API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create New Task action
1. Connect your Kanbanize account
2. Select a Board Id
3. Optional- Configure Title
4. Optional- Configure Description
5. Optional- Select a Type
6. Optional- Select a Assignee
7. Optional- Select a Column
8. Optional- Select a Lane
9. Optional- Configure Position
10. Optional- Select a Template
11. Optional- Configure Exceeding Reason
12. Optional- Select a Priority
13. Optional- Configure Size
14. Optional- Configure External Link
15. Optional- Configure Deadline
16. Optional- Configure Color
17. Optional- Configure Tags
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#

Monthly Schedule on Schedule

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

Version:0.0.2

Key:schedule-monthly

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: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month 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 New Task on Kanbanize

Description:Create New Task. [See the docs here](https://kanbanize.com/api)

Version:0.0.1

Key:kanbanize-create-new-task

View on GitHub

Kanbanize Overview#

The Kanbanize API enables the automation of complex project management workflows within Kanban boards. By leveraging the API, you can create, update, and move cards, manage board configurations, and integrate real-time updates with other tools. It's a powerful way to streamline project tracking, automate task assignments, and synchronize data across various project management platforms.

Action Code#

import kanbanizeApp from "../../kanbanize.app.mjs";

export default {
  key: "kanbanize-create-new-task",
  name: "Create New Task",
  description: "Create New Task. [See the docs here](https://kanbanize.com/api)",
  version: "0.0.1",
  type: "action",
  props: {
    kanbanizeApp,
    boardId: {
      description: "The ID of the board whose structure you want to get.\n\nYou can see the board ID on the dashboard screen, in the upper right corner of each board.",
      propDefinition: [
        kanbanizeApp,
        "boardId",
      ],
    },
    title: {
      propDefinition: [
        kanbanizeApp,
        "title",
      ],
    },
    description: {
      propDefinition: [
        kanbanizeApp,
        "description",
      ],
    },
    type: {
      propDefinition: [
        kanbanizeApp,
        "type",
        (c) => ({
          boardId: c.boardId,
        }),
      ],
    },
    assignee: {
      propDefinition: [
        kanbanizeApp,
        "assignee",
        (c) => ({
          boardId: c.boardId,
        }),
      ],
    },
    column: {
      label: "Column",
      description: "The name of the column to create the task into (default is Backlog).",
      type: "string",
      optional: true,
      async options() {
        if (!this.boardId) {
          return [];
        }
        return this.kanbanizeApp.getBoardsColumns(this.boardId);
      },
    },
    lane: {
      label: "Lane",
      description: "The name of the swimlane to put the newly created task into.\n\nIf omitted, the task will be placed in the first swimlane.",
      type: "string",
      optional: true,
      async options() {
        if (!this.boardId) {
          return [];
        }
        return this.kanbanizeApp.getBoardsLanes(this.boardId);
      },
    },
    position: {
      label: "Position",
      description: "The position of the task in the new column/swimlane (zero-based).\n\nIf omitted, the task will be placed at the bottom of the column.",
      type: "integer",
      optional: true,
    },
    template: {
      label: "Template",
      description: "The name of the template you want to apply.\n\nIf you specify any property as part of the request, the one specified in the template will be overwritten.",
      type: "string",
      optional: true,
      async options() {
        if (!this.boardId) {
          return [];
        }
        return this.kanbanizeApp.getTemplates(this.boardId);
      },
    },
    exceedingReason: {
      label: "Exceeding Reason",
      description: "If you can exceed a limit with a reason, supply it with this parameter.\n\nApplicable only if column, lane and/or position are supplied.",
      type: "string",
      optional: true,
    },
    priority: {
      propDefinition: [
        kanbanizeApp,
        "priority",
      ],
    },
    size: {
      propDefinition: [
        kanbanizeApp,
        "size",
      ],
    },
    extLink: {
      propDefinition: [
        kanbanizeApp,
        "extLink",
      ],
    },
    deadline: {
      propDefinition: [
        kanbanizeApp,
        "deadline",
      ],
    },
    color: {
      propDefinition: [
        kanbanizeApp,
        "color",
      ],
    },
    tags: {
      propDefinition: [
        kanbanizeApp,
        "tags",
      ],
    },
  },
  async additionalProps() {
    if (!this.boardId) {
      return {};
    }
    return this.kanbanizeApp.getCustomFieldsProps(this.boardId);
  },
  methods: {
    removeUnusedParams(searchParams) {
      return Object.keys(searchParams).reduce((acc, key) => (
        (searchParams[key] === undefined || searchParams[key] === null) ?
          acc :
          {
            ...acc,
            [key]: searchParams[key],
          }
      ), {});
    },
    async getCustomFieldsParams(boardId) {
      const customFieldsTaskParam = {};
      const customFields = await this.kanbanizeApp.getCustomFields(boardId);
      for (const customField of customFields) {
        customFieldsTaskParam[customField.name] = this[`cf-${customField.fieldid}`];
      }
      return customFieldsTaskParam;
    },
  },
  async run({ $ }) {
    const customFieldsTaskParam = await this.getCustomFieldsParams(this.boardId);
    const taskParam = this.removeUnusedParams({
      ...customFieldsTaskParam,
      boardid: this.boardId,
      title: this.title,
      description: this.description,
      priority: this.priority,
      extlink: this.extLink,
      deadline: this.deadline,
      type: this.type,
      assignee: this.assignee,
      column: this.column,
      lane: this.lane,
      template: this.template,
      size: this.size,
      position: this.position,
      exceedingreason: this.exceedingReason,
      tags: this.tags ?
        this.tags.join(" ") :
        null,
      color: this.color ?
        this.color.replace("#", "") :
        null,
      returntaskdetails: 1,
    });
    const response = await this.kanbanizeApp.createNewTask(taskParam);
    $.export("$summary", `Successfully created new task #${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
Kanbanize	`kanbanizeApp`	`app`	This component uses the Kanbanize app.
Board Id	`boardId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	Title of the task.
Description	`description`	`string`	Description of the task.
Type	`type`	`string`	Select a value from the drop down menu.
Assignee	`assignee`	`string`	Select a value from the drop down menu.
Column	`column`	`string`	Select a value from the drop down menu.
Lane	`lane`	`string`	Select a value from the drop down menu.
Position	`position`	`integer`	The position of the task in the new column/swimlane (zero-based). If omitted, the task will be placed at the bottom of the column.
Template	`template`	`string`	Select a value from the drop down menu.
Exceeding Reason	`exceedingReason`	`string`	If you can exceed a limit with a reason, supply it with this parameter. Applicable only if column, lane and/or position are supplied.
Priority	`priority`	`string`	Select a value from the drop down menu:`lowaveragehigh`
Size	`size`	`integer`	Size of the task.
External Link	`extLink`	`string`	A external link in the following format: `https://domain.com/resource`
Deadline	`deadline`	`string`	Deadline in the format: yyyy-mm-dd (e.g. 2011-12-13).
Color	`color`	`string`	Any color code (e.g. #34A97B).
Tags	`tags`	`string[]`	List of tags.

Action Authentication#

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

To generate an API key, go to your account, click on the user dropdown menu at the top right corner of your Kanbanize account and select "API".
If your Kanbanize URL is https://12345678.kanbanize.com/, your subdomain is 12345678.