Monday.com is a work operating system that powers teams to run projects and workflows with confidence.

Categories: Project Management

Type: monday/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true

Connection Setup

Connect monday.com to ByteChef using OAuth 2.0 (Authorization Code).

Create an OAuth app in monday.com

Open monday.com and click your profile avatar (top-right).
Click on Developers to open the Developer Center.
Click Create app (or open your existing app).
Give the app a clear name, for example ByteChef Integration.
In the left menu, open Build and choose OAuth & permissions.
Add the following scopes (minimum required by ByteChef):
- boards:read
- boards:write
- workspaces:read
- webhooks:write
Save the scopes.
Click on Redirect URLs and add the ByteChef OAuth redirect (callback) URL(s):
- Cloud: https://app.bytechef.io/callback
- Local development: http://127.0.0.1:5173/callback or http://localhost:5173/callback
Go back to General settings and copy your Client ID and Client Secret for later.

Actions

Create Board

Name: createBoard

Create a new board.

Properties

Name	Label	Type	Description	Required
board_name	Board Name	STRING	Name of the new board.	true
board_kind	Board Kind	STRING Options private, public, share	The type of board to create.	true
description	Description	STRING	Detailed description of the new board.	false

Example JSON Structure

{
  "label" : "Create Board",
  "name" : "createBoard",
  "parameters" : {
    "board_name" : "",
    "board_kind" : "",
    "description" : ""
  },
  "type" : "monday/v1/createBoard"
}

Properties

Name	Type	Description
create_board	OBJECT Properties {STRING(id), STRING(name)}

Output Example

{
  "create_board" : {
    "id" : "",
    "name" : ""
  }
}

Create Column

Name: createColumn

Create a new column in an existing board.

Properties

Name	Label	Type	Description	Required
workspace_id	Workspace ID	STRING	ID of the workspace where the board is located.	false
board_id	Board ID	STRING Depends On workspace_id	ID of the board where the new column should be created.	true
title	Title	STRING	The new column's title.	true
column_type	Column Type	STRING Options auto_number, board_relation, button, checkbox, color_picker, country, creation_log, date, dependency, doc, dropdown, email, file, formula, hour, item_assignees, item_id, last_updated, link, location, long_text, mirror, name, numbers, people, phone, progress, rating, status, subtasks, tags, team, text, timeline, time_tracking, vote, week, world_clock, unsupported	The type of column to create.	true

Example JSON Structure

{
  "label" : "Create Column",
  "name" : "createColumn",
  "parameters" : {
    "workspace_id" : "",
    "board_id" : "",
    "title" : "",
    "column_type" : ""
  },
  "type" : "monday/v1/createColumn"
}

Properties

Name	Type	Description
create_column	OBJECT Properties {STRING(id), STRING(title)}

Output Example

{
  "create_column" : {
    "id" : "",
    "title" : ""
  }
}

Create Group

Name: createGroup

Creates a new group in an existing board.

Properties

Name	Label	Type	Description	Required
workspace_id	Workspace ID	STRING	ID of the workspace where the board is located.	false
board_id	Board ID	STRING Depends On workspace_id	ID of the board where new item will be created.	true
group_name	Group Name	STRING	The new group's name.	true

Example JSON Structure

{
  "label" : "Create Group",
  "name" : "createGroup",
  "parameters" : {
    "workspace_id" : "",
    "board_id" : "",
    "group_name" : ""
  },
  "type" : "monday/v1/createGroup"
}

Properties

Name	Type	Description
create_group	OBJECT Properties {STRING(id), STRING(name)}

Output Example

{
  "create_group" : {
    "id" : "",
    "name" : ""
  }
}

Create Item

Name: createItem

Create a new item in an existing board.

Properties

Name	Label	Type	Description	Required
workspace_id	Workspace ID	STRING	ID of the workspace where the board is located.	false
board_id	Board ID	STRING Depends On workspace_id	ID of the board where new item will be created.	true
group_id	Group ID	STRING Depends On workspace_id, board_id	The item's group.	false
item_name	Item Name	STRING	The item's name.	true
columnValues		DYNAMIC_PROPERTIES Depends On workspace_id, board_id, group_id		false

Example JSON Structure

{
  "label" : "Create Item",
  "name" : "createItem",
  "parameters" : {
    "workspace_id" : "",
    "board_id" : "",
    "group_id" : "",
    "item_name" : "",
    "columnValues" : { }
  },
  "type" : "monday/v1/createItem"
}

Properties

Name	Type	Description
create_item	OBJECT Properties {STRING(id), STRING(name)}

Output Example

{
  "create_item" : {
    "id" : "",
    "name" : ""
  }
}

Delete Item

Name: deleteItem

Deletes an item from an existing board.

Properties

Name	Label	Type	Description	Required
workspace_id	Workspace ID	STRING	ID of the workspace where the board is located.	false
board_id	Board ID	STRING Depends On workspace_id	ID of the board where the item is located.	false
item_id	Item ID	STRING Depends On board_id, workspace_id	ID of the item to delete.	true

Example JSON Structure

{
  "label" : "Delete Item",
  "name" : "deleteItem",
  "parameters" : {
    "workspace_id" : "",
    "board_id" : "",
    "item_id" : ""
  },
  "type" : "monday/v1/deleteItem"
}

Output

This action does not produce any output.

Get Board Values

Name: getBoardValues

Get a list of board's items.

Properties

Name	Label	Type	Description	Required
workspace_id	Workspace ID	STRING	ID of the workspace where the board is located.	false
board_id	Board ID	STRING Depends On workspace_id	ID of the board to return values for.	true
columns	Columns	ARRAY Items [STRING]	Select specific columns to return values for. If empty, all columns will be returned.	false

Example JSON Structure

{
  "label" : "Get Board Values",
  "name" : "getBoardValues",
  "parameters" : {
    "workspace_id" : "",
    "board_id" : "",
    "columns" : [ "" ]
  },
  "type" : "monday/v1/getBoardValues"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Update Item Status

Name: updateItemStatus

Update status column on a specific item. Available only for boards that have defined status column.

Properties

Name	Label	Type	Description	Required
workspace_id	Workspace ID	STRING	ID of the workspace where the board is located.	false
board_id	Board ID	STRING Depends On workspace_id	ID of the board where the item is located. Returns only boards with defined status column.	true
column_id	Column ID	STRING Depends On workspace_id, board_id	Column ID.	true
item_id	Item ID	STRING Depends On board_id, workspace_id	ID of the item to update.	true
status	Status	STRING Depends On board_id, column_id	The status label.	true

Example JSON Structure

{
  "label" : "Update Item Status",
  "name" : "updateItemStatus",
  "parameters" : {
    "workspace_id" : "",
    "board_id" : "",
    "column_id" : "",
    "item_id" : "",
    "status" : ""
  },
  "type" : "monday/v1/updateItemStatus"
}

Properties

Name	Type	Description
change_column_value	OBJECT Properties {STRING(id), STRING(name)}

Output Example

{
  "change_column_value" : {
    "id" : "",
    "name" : ""
  }
}

Triggers

New Item in Board

Name: newItemInBoard

Triggers when an item is created in board.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
workspace_id	Workspace ID	STRING	ID of the workspace where the board is located.	false
board_id	Board ID	STRING Depends On workspace_id	ID of the board to monitor for new items.	true

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "New Item in Board",
  "name" : "newItemInBoard",
  "parameters" : {
    "workspace_id" : "",
    "board_id" : ""
  },
  "type" : "monday/v1/newItemInBoard"
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

Additional Instructions

How to find Workspace ID

Method 1: Via UI

To find a Workspace ID, open the workspace. In URL you can find the Workspace ID. For example if URL is https://bytechef.monday.com/workspaces/123, your ID is 123.

Method 2: Via API

You can use query{workspaces{id name}}.

How to find Board ID

Method 1: Via UI

To find a Board ID, open the board. In URL you can find the Board ID. For example if URL is https://bytechef.monday.com/boards/123, your ID is 123.

Method 2: Via API

You can use query{boards(workspace_ids: WORKSPACE_ID, order_by: created_at){id name}}.

How to find Group ID

Method 1: Via UI

To find Group ID, open the board where group is located. Click on three dots in front of group name and there you will find Group ID.

Method 2: Via API

You can use query{boards(ids: BOARD_ID){groups{id title}}}.

How to find Item ID

Method 1: Via UI

To find Item ID, open the item page. In URL you can find the Item ID. For example if URL is https://bytechef.monday.com/boards/123/pulses/456, your ID is 456.

Method 2: Via API

You can use query{boards(ids: BOARD_ID){items_page{items{id name}}}}.

How to find Column ID

Method 1: Via UI

To find Column ID, open the board. Click on three dots next to the column name and there you will find Column ID.

Method 2: Via API

You can use query{boards(ids: BOARD_ID){columns {id title}}}.

How to find Status

Method 1: Via UI

To find status labels, open the board. By clicking on status field for each item, you can find available status labels.

monday.com

On this page