KanbanFlow

The KanbanFlow modules allow you to watch, create, update, list, and delete the tasks in your KanbanFlow account.

Getting Started with KanbanFlow

Prerequisites

A KanbanFlow account

In order to use KanbanFlow with Boost.space Integrator, it is necessary to have a KanbanFlow account. If you do not have one, you can create a KanbanFlow account at kanbanflow.com/.

Connecting KanbanFlow to Boost.space Integrator

To connect your KanbanFlow account to Boost.space Integrator you need to obtain the API token from your KanbanFlow account and insert it in the Create a connection dialog in the Boost.space Integrator module.

1. Log in to your KanbanFlow account.

2. Open any board, click Menu > Settings > API & Webhooks > Add API Token.

3. Enter a name for the API token, select the permissions, and click Add Token.

4. Copy the API token to your clipboard.

5. Go to Boost.space Integrator and open the KanbanFlow module’s _Create a connectio_n dialog.

6. In the Connection name field, enter a name for the connection.

7. In the API Token field, enter the API token copied in step 4 and click Continue.

The connection has been established.

Triggers

Watch New Tasks

Triggers when a new task is created.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your KanbanFlow account.

See the Connecting to KanbanFlow Webhook using Boost.space Integratorto add the webhook in your KanbanFlow account.

Watch Task Moved

Triggers when a task is moved between columns or swimlanes.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your KanbanFlow account.

See the Connecting to KanbanFlow Webhook using Boost.space Integratorto add the webhook in your KanbanFlow account.

Actions

Get a Task

Returns information about a specified task.

Connection

Establish a connection to your KanbanFlow account.

Choose Task

Select the option to choose the task:

Enter Manually
By Column

Column

Select the column whose details you want to retrieve.

Task ID

Enter the Task ID whose details you want to retrieve.

Create a Task

Creates a new task.

Connection

Establish a connection to your KanbanFlow account.

Name

Enter the name of the task.

Column ID

Select the Column ID of the task:

To-do
Do today
In progress
Done

Swimlane ID

(Optional) If the board has swimlanes, select the Swimlane ID.

Position

Select the position of the task in the list. For example, top, bottom, or a number.

Description

Enter the details of the task.

Color

Select the color for the task.

Responsible User

Select the user who is responsible for the task.

Total Seconds Estimate

Enter the estimated time for completing the task in seconds.

Grouping Date

Enter the date if the column date is grouped.

Labels

Add the labels:

Name

Enter the name of the label.

Pinned

Select whether you want to pin the label:

Yes
No
Not defined

Subtasks

Add the subtasks:

Name

Enter the name of the subtask.

Finished

Select whether the task is finished:

Yes
No
Not defined

User

Select the user to whom the task is assigned.

Due Date

Enter the due date by when the task must be completed.

Due Date (Local)

Enter the local date in the user’s timezone by when the task must be complete.

Dates

Add the due dates for the task:

Due Time

Enter the date by when the task must be complete.

Column

Select the column:

To-do
Do today
In progress
Done

Status

Select the status of the task:

Active
Done

Due Time (Local)

Enter the local date in the user’s timezone by when the task must be complete.

Collaborators

Select the user who will be the collaborators in this task.

Update a Task

Updates information about a specified task.

Connection

Establish a connection to your KanbanFlow account.

Choose Task

Select the option to choose the task:

By Column
Enter Manually

Column

Select the Column type of the task you want to update.

Task

Select the task you want to update.

Task ID

Enter the Task ID whose details you want to update.

Name

Enter the name of the task.

Column ID

Select the Column ID of the task:

To-do
Do today
In progress
Done

Swimlane ID

(Optional) If the board has swimlanes, select the Swimlane ID.

Position

Select the position of the task in the list. For example, top, bottom, or a number.

Description

Enter the details of the task.

Color

Select the color for the task.

Responsible User

Select the user who is responsible for the task.

Total Seconds Estimate

Enter the estimated time for completing the task in seconds.

Grouping Date

Enter the date if the column date is grouped.

Labels

Add the labels:

Name

Enter the name of the label.

Pinned

Select whether you want to pin the label:

Yes
No
Not defined

Subtasks

Add the subtasks:

Name

Enter the name of the subtask.

Finished

Select whether the task is finished:

Yes
No
Not defined

User

Select the user to whom the task is assigned.

Due Date

Enter the due date by when the task must be completed.

Due Date (Local)

Enter the local date in the user’s timezone by when the task must be complete.

Dates

Add the due dates for the task:

Due Time

Enter the date by when the task must be complete.

Column

Select the column:

To-do
Do today
In progress
Done

Status

Select the status of the task:

Active
Done

Due Time (Local)

Enter the local date in the user’s timezone by when the task must be complete.

Collaborators

Select the user who will be the collaborators in this task.

Delete a Task

Deletes a specified task.

Connection

Establish a connection to your KanbanFlow account.

Choose Task

Select the option to choose the task:

By Column
Enter Manually

Column

Select the Column type of the task you want to delete.

Task

Select the task you want to delete.

Task ID

Enter the Task ID you want to delete.

Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your KanbanFlow account.

URL

Enter a path relative to https://kanbanflow.com/api For example: /v1/users

For the list of available endpoints, refer to the KanbanFlow API Documentation. This can be found in your board API & Webhooks settings > Show documentation: https://kanbanflow.com/administration/board/<yourBoardId>/api

Method

Select the HTTP method you want to use:

GET to retrieve information for an entry.

POST to create a new entry.

PUT to update/replace an existing entry.

PATCH to make a partial entry update.

DELETE to delete an entry.

Headers

Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use – Get Tasks

The following API call returns all the tasks from your KanbanFlow account:

URL:

/v1/tasks

Method:

GET

Matches of the search can be found in the module’s Output under Bundle > _Body._In our example, 4 tasks were returned:

Searches

List Tasks

Returns a list of tasks.

Connection

Establish a connection to your KanbanFlow account.

Column

Select the column whose tasks you want to list.

Limit

Set the number of returned tasks Boost.space Integrator will return during one execution cycle.

Connecting to a KanbanFlow Webhook using Boost.space Integrator

1. Open thetrigger module for which you want to receive the alerts, establish the connection as mentioned in the respective module, and copy the address to your clipboard.