Monday Component
Manage boards, items, and columns inside your Monday account.
Component key: mondayDescription#
Monday is a Cloud-based platform that allows companies to create their own applications and work management software. The Monday component allows you to manage columns, items, and subscribers in a Monday board.
Authorization Notes#
API key#
The Monday component requires an API key to authenticate requests to the Monday GraphQL API. You can configure a Monday Personal API token from your user admin settings. For more information refer to the Monday docs
OAuth 2.0#
You can configure an OAuth 2.0 credential by registering a monday app Be sure to enter your prismatic Callback URL in the app configuration. Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.
- For Client ID and Client Secret enter the values that you got from your Monday app.
- For Scopes and permission choose from the options found on the Monday docs
- For Authorization URL enter https://auth.monday.com/oauth2/authorize
- For Access Token URL enter https://auth.monday.com/oauth2/token
Actions#
Add Subscribers To Board#
Add the given users to the board's subscribers | key: addSubscribers
| Input | Key | Notes | Example |
|---|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board | |
Users string / Required | users | For each item, provide the unique identifier of the user. | 793400 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Archive Board#
Delete the information and metadata of a board by Id | key: archiveBoard
| Input | Key | Notes |
|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Archive Item#
Delete the information and metadata of an item by Id | key: archiveItem
| Input | Key | Notes | Example |
|---|---|---|---|
Item Id string / Required | itemId | Provide the unique identifier of the item. | 098093745 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Create Board#
Create a new board inside your Monday account | key: createBoard
| Input | Key | Notes | Example |
|---|---|---|---|
Board Kind string / Required | boardKind | Provide a string value for the kind of board. | public |
Board Name string / Required | boardName | Provide a string value for the name of the board. | |
Folder Id string | folderId | Provide the unique identifier of the folder. | |
Template Id string | templateId | Provide the unique identifier of the template that your board extends. | |
Workspace Id string | workspaceId | Provide the unique identifier of the workspace. |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Create Column#
Create a new column inside an existing board | key: createColumn
| Input | Key | Notes | Example |
|---|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board | |
Column Title string / Required | columnTitle | Provide a string value for the title of the column. | Due Date |
Column Type string / Required | columnType | Provide a valid column type. Chose from the list of simple and complex column types found here: https://support.monday.com/hc/en-us/articles/115005310285-What-are-the-column-choices- | status |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Create Item#
Create a new item inside of a board | key: createItem
| Input | Key | Notes | Example |
|---|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board | |
Column Values string / Required | columnValues | Provide the unique identifier of the group your item will belong to. | |
Group Id string / Required | groupId | Provide the unique identifier of the group your item will belong to. | |
Item Name string / Required | itemName | Provide string value for the name of the item. | exampleItem |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Create Update#
Create a new update with additional notes and information to add to items outside of their columns. | key: createUpdate
| Input | Key | Notes | Example |
|---|---|---|---|
Item Id string / Required | itemId | Provide the unique identifier of the item. | 098093745 |
Parent Id string / Required | parentId | Provide the unique identifier of the parent object. | 793400 |
Update Body string / Required | updateBody | Provide a string value for the body of the update. | This is an example update! |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Delete Subscribers From Board#
Remove the given subscribers from an existing board | key: deleteSubscribers
| Input | Key | Notes | Example |
|---|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board | |
Users string / Required | users | For each item, provide the unique identifier of the user. | 793400 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Delete Update#
Delete an update of an existing item | key: deleteUpdate
| Input | Key | Notes | Example |
|---|---|---|---|
Update Id string / Required | updateId | Provide the unique identifier of the update Id. | 793400 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Get Board#
Get the information and metadata of a board by Id | key: getBoard
| Input | Key | Notes |
|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Get Columns In Board#
Get the information and metadata of all columns in a given board | key: getColumn
| Input | Key | Notes |
|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Get Items By Column Value#
Get the information and metadata of an item by Column Value | key: getItemsByColumnValue
| Input | Key | Notes | Example |
|---|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board | |
Column Id string / Required | columnId | Provide the Id of the column. | status |
Column Value string / Required | columnValue | Provide the value to update the column with. | Example Value |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
List Boards#
List all available boards in your Monday account | key: listBoards
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
List Items#
Get the information and metadata of an item by Id | key: listItems
| Input | Key | Notes | Example |
|---|---|---|---|
Items string / Required | itemList | Provide the unique identifier for each item. | 780497 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
List Updates#
List all updates that have been created | key: listUpdates
| Input | Key | Notes | Example |
|---|---|---|---|
Update Id string / Required | updateId | Provide the unique identifier of the update Id. | 793400 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Update Column Title#
Update the title of an existing column | key: updateColumnTitle
| Input | Key | Notes | Example |
|---|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board | |
Column Id string / Required | columnId | Provide the Id of the column. | status |
Column Title string / Required | columnTitle | Provide a string value for the title of the column. | Due Date |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |
Update Column Value#
Update the given column value | key: updateColumnValue
| Input | Key | Notes | Example |
|---|---|---|---|
Board Id string / Required | boardId | Provide the unique identifier of the board | |
Column Id string / Required | columnId | Provide the Id of the column. | status |
Column Value string / Required | columnValue | Provide the value to update the column with. | Example Value |
Item Id string / Required | itemId | Provide the unique identifier of the item. | 098093745 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| API Key | api_key | API authorization based on an API key | API Key | api_key |
| OAuth 2.0 - Authorization Code | oauth2 | OAuth 2.0 authorization using the authorization code grant type | Client ID | client_id Client Secret | client_secret Scopes | scopes Authorization URL | auth_uri Access Token URL | token_uri |