Connectors Reference

Kanbanize

The Kanbanize connector allows you to create, update or move cards inside your Kanban boards, as well as to retrieve information about your boards and their structure. Other supported functions are adding comments or logging time on the cards.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

MoveCard ([advanced]string Content-Type, [advanced]string Accept, [Optional]MoveCardParameterBody body)

Move Card

LogTime ([advanced]string Content-Type, [advanced]string Accept, [Optional]LogTimeParameterBody body)

Log Time

GetBoards ()

Get Boards

CreateCard ([advanced][Optional]string Content-Type, [advanced][Optional]string Accept, [Optional]CreateCardParameterBody body)

Create Card

CreateSubtask ([advanced]string Content-Type, [advanced]string Accept, [Optional]CreateSubtaskParameterBody body)

Create Subtask

AddComment ([advanced]string Content-Type, [advanced]string Accept, [Optional]AddCommentParameterBody body)

Add Comment

GetColumns (string board_id)

Get Board Columns

GetLanes (string board_id)

Get Lanes

GetTypes ()

Get Types

UpdateCard ([advanced]string Content-Type, [advanced]string Accept, [Optional]UpdateCardParameterBody body)

Update Card

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AddCommentParameterBody

 

AddCommentResponse

 

CreateCardParameterBody

 

CreateCardResponse

 

CreateSubtaskParameterBody

 

CreateSubtaskResponse

 

GetBoardsResponse

 

GetColumnsResponse

 

GetLanesResponse

 

GetTypesResponse

 

LogTimeParameterBody

 

LogTimeResponse

 

MoveCardParameterBody

 

MoveCardResponse

 

UpdateCardParameterBody

 

UpdateCardResponse

 

 

Actions:

MoveCard

Summary: Move Card

Description: Move a card (Task or Initiative, if possible) to a column.

 

Syntax:

Kanbanize.MoveCard ([advanced]string Content-Type, [advanced]string Accept, [Optional]MoveCardParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(Content Type)

Always use: application/json

True

Accept

string

(Content Type)

Always use: application/json

True

body

MoveCardParameterBody

 

 

False

 

Returns:

          Type:MoveCardResponse

 

LogTime

Summary: Log Time

Description: Log time to a card. The time is logged in minutes.

 

Syntax:

Kanbanize.LogTime ([advanced]string Content-Type, [advanced]string Accept, [Optional]LogTimeParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(Content Type)

Always use: application/json

True

Accept

string

(Content Type)

Always use: application/json

True

body

LogTimeParameterBody

 

 

False

 

Returns:

          Type:LogTimeResponse

 

GetBoards

Summary: Get Boards

Description: Get all boards from the account.

 

Syntax:

Kanbanize.GetBoards ()

 

Returns:

          Type:GetBoardsResponse

 

CreateCard

Summary: Create Card

Description: Create a card in a board of your chocie

 

Syntax:

Kanbanize.CreateCard ([advanced][Optional]string Content-Type, [advanced][Optional]string Accept, [Optional]CreateCardParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(Content Type)

Always use: application/json

False

Accept

string

(Content Type)

Always use: application/json

False

body

CreateCardParameterBody

 

 

False

 

Returns:

          Type:CreateCardResponse

 

CreateSubtask

Summary: Create Subtask

Description: Creates a new subtask of a card or initiative

 

Syntax:

Kanbanize.CreateSubtask ([advanced]string Content-Type, [advanced]string Accept, [Optional]CreateSubtaskParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(Content Type)

Always use: application/json

True

Accept

string

(Content Type)

Always use: application/json

True

body

CreateSubtaskParameterBody

 

 

False

 

Returns:

          Type:CreateSubtaskResponse

 

AddComment

Summary: Add Comment

Description: Adds a comment to a card or initiative.

 

Syntax:

Kanbanize.AddComment ([advanced]string Content-Type, [advanced]string Accept, [Optional]AddCommentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(Content Type)

Always use: application/json

True

Accept

string

(Content Type)

Always use: application/json

True

body

AddCommentParameterBody

 

 

False

 

Returns:

          Type:AddCommentResponse

 

GetColumns

Summary: Get Board Columns

Description: Gets all columns for a specified board.

 

Syntax:

Kanbanize.GetColumns (string board_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board ID)

The board to get the columns for.

True

 

Returns:

          Type:GetColumnsResponse

 

GetLanes

Summary: Get Lanes

Description: Gets all lanes for a specified board.

 

Syntax:

Kanbanize.GetLanes (string board_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board ID)

The board to get the lanes for.

True

 

Returns:

          Type:GetLanesResponse

 

GetTypes

Summary: Get Types

Description: Gets all types within the account.

 

Syntax:

Kanbanize.GetTypes ()

 

Returns:

          Type:GetTypesResponse

 

UpdateCard

Summary: Update Card

Description: Update the properties of a card (Title, Description, Priority, etc.)

 

Syntax:

Kanbanize.UpdateCard ([advanced]string Content-Type, [advanced]string Accept, [Optional]UpdateCardParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(Content Type)

Always set to: application/json

True

Accept

string

(Accept)

Always set to: application/json

True

body

UpdateCardParameterBody

 

 

False

 

Returns:

          Type:UpdateCardResponse

 


 

AddCommentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

taskid

string

 

taskid

comment

string

 

comment


 

AddCommentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateCardParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

boardid

string

 

boardid

title

string

 

title

description

string

 

description

priority

string

 

priority

assignee

string

 

assignee

color

string

 

color

size

string

 

size

tags

string

 

tags

deadline

string

 

deadline

extlink

string

 

extlink

type

string

 

type

template

string

 

template

column

string

 

column

lane

string

 

lane

position

string

 

position

exceedingreason

string

 

exceedingreason


 

CreateCardResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateSubtaskParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

taskparent

integer(int32)

 

taskparent

title

string

 

title

assignee

string

 

assignee


 

CreateSubtaskResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetBoardsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

data

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

board_id

integer(int32)

 

board_id

workspace_id

integer(int32)

 

workspace_id

is_archived

integer(int32)

 

is_archived

name

string

 

name

 


 

GetColumnsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

data

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

column_id

integer(int32)

 

column_id

workflow

integer(int32)

 

workflow

section

integer(int32)

 

section

parent_column_id

integer(int32)

 

parent_column_id

position

integer(int32)

 

position

name

string

 

name

description

string

 

description

color

string

 

color

limit

integer(int32)

 

limit

cards_per_row

integer(int32)

 

cards_per_row

flow_type

integer(int32)

 

flow_type

 


 

GetLanesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

data

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

lane_id

integer(int32)

 

lane_id

workflow

integer(int32)

 

workflow

parent_lane_id

integer(int32)

 

parent_lane_id

position

integer(int32)

 

position

name

string

 

name

description

string

 

description

color

string

 

color

 


 

GetTypesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

data

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

type_id

integer(int32)

 

type_id

icon_type

integer(int32)

 

icon_type

icon_id

integer(int32)

 

icon_id

name

string

 

name

description

string

 

description

color

string

 

color

card_color_sync

integer(int32)

 

card_color_sync

all_properties_are_locked

integer(int32)

 

all_properties_are_locked

availability

integer(int32)

 

availability

is_enabled

integer(int32)

 

is_enabled

 


 

LogTimeParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

card_id

string

 

card_id

time

string

 

time

comment

string

 

comment


 

LogTimeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

MoveCardParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

taskid

string

 

taskid

boardid

string

 

boardid

column

string

 

column

lane

string

 

lane

position

string

 

position

exceedingreason

string

 

exceedingreason


 

MoveCardResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

UpdateCardParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

boardid

integer(int32)

 

boardid

taskid

integer(int32)

 

taskid

title

string

 

title

description

string

 

description

priority

string

 

priority  Values: [Low, Average, High, Critical]

assignee

string

 

assignee

color

string

 

color

size

integer(int32)

 

size

tags

string

 

tags

deadline

string

 

deadline

extlink

string

 

extlink

type

string

 

type


 

UpdateCardResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary