Monday Component
Manage boards, items, and columns inside your Monday account.
Component key: monday#
DescriptionMonday 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.
#
Monday Connections#
API KeyThe 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 documentation.
Input | Notes |
---|---|
Input API Key string / Required | Notes API Key |
#
OAuth 2.0To configure OAuth 2.0 you will first need to register a Monday app. Ensure that the Prismatic Callback URL is added to the app in Monday.
Now you will need to add the Monday component's OAuth 2.0 connection to your integration and configure it with:
- For Client ID and Client Secret enter the values that you got from your Monday app.
- For Scopes refer to Monday's OAuth 2.0 documentation.
Input | Default | Notes | Example |
---|---|---|---|
Input Authorize URL string / Required Hidden Field | Default https://auth.monday.com/oauth2/authorize | Notes The OAuth 2.0 Authorization URL for Monday | Example |
Input Client ID string / Required | Default | Notes Client Identifier of your app for Monday | Example |
Input Client Secret password / Required | Default | Notes Client Secret of your app for Monday | Example |
Input Scopes string | Default | Notes Space separated OAuth 2.0 permission scopes for Monday | Example me:read boards:read |
Input Token URL string / Required Hidden Field | Default https://auth.monday.com/oauth2/token | Notes The OAuth 2.0 Token URL for Monday | Example |
#
Actions#
Add Subscribers To BoardAdd the given users to the board's subscribers | key: addSubscribers
Input | Notes | Example |
---|---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board | Example |
Input Connection connection / Required | Notes | Example |
Input Users string / Required Value List | Notes For each item, provide the unique identifier of the user. | Example 793400 |
#
Archive BoardDelete the information and metadata of a board by Id | key: archiveBoard
Input | Notes |
---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board |
Input Connection connection / Required | Notes |
#
Archive ItemDelete the information and metadata of an item by Id | key: archiveItem
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Item Id string / Required | Notes Provide the unique identifier of the item. | Example 098093745 |
#
Create BoardCreate a new board inside your Monday account | key: createBoard
Input | Notes | Example |
---|---|---|
Input Board Kind string / Required | Notes Provide a string value for the kind of board. | Example public |
Input Board Name string / Required | Notes Provide a string value for the name of the board. | Example |
Input Connection connection / Required | Notes | Example |
Input Folder Id string | Notes Provide the unique identifier of the folder. | Example |
Input Template Id string | Notes Provide the unique identifier of the template that your board extends. | Example |
Input Workspace Id string | Notes Provide the unique identifier of the workspace. | Example |
#
Create ColumnCreate a new column inside an existing board | key: createColumn
Input | Notes | Example |
---|---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board | Example |
Input Column Title string / Required | Notes Provide a string value for the title of the column. | Example Due Date |
Input Column Type string / Required | Notes 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- | Example status |
Input Connection connection / Required | Notes | Example |
#
Create ItemCreate a new item inside of a board | key: createItem
Input | Notes | Example |
---|---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board | Example |
Input Column Values string / Required | Notes Provide the unique identifier of the group your item will belong to. | Example |
Input Connection connection / Required | Notes | Example |
Input Group Id string / Required | Notes Provide the unique identifier of the group your item will belong to. | Example |
Input Item Name string / Required | Notes Provide string value for the name of the item. | Example exampleItem |
#
Create UpdateCreate a new update with additional notes and information to add to items outside of their columns. | key: createUpdate
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Item Id string / Required | Notes Provide the unique identifier of the item. | Example 098093745 |
Input Parent Id string / Required | Notes Provide the unique identifier of the parent object. | Example 793400 |
Input Update Body string / Required | Notes Provide a string value for the body of the update. | Example This is an example update! |
#
Delete Subscribers From BoardRemove the given subscribers from an existing board | key: deleteSubscribers
Input | Notes | Example |
---|---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board | Example |
Input Connection connection / Required | Notes | Example |
Input Users string / Required Value List | Notes For each item, provide the unique identifier of the user. | Example 793400 |
#
Delete UpdateDelete an update of an existing item | key: deleteUpdate
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Update Id string / Required | Notes Provide the unique identifier of the update Id. | Example 793400 |
#
Get BoardGet the information and metadata of a board by Id | key: getBoard
Input | Notes |
---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board |
Input Connection connection / Required | Notes |
#
Get Columns In BoardGet the information and metadata of all columns in a given board | key: getColumn
Input | Notes |
---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board |
Input Connection connection / Required | Notes |
#
Get Items By Column ValueGet the information and metadata of an item by Column Value | key: getItemsByColumnValue
Input | Notes | Example |
---|---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board | Example |
Input Column Id string / Required | Notes Provide the Id of the column. | Example status |
Input Column Value string / Required | Notes Provide the value to update the column with. | Example Example Value |
Input Connection connection / Required | Notes | Example |
#
List BoardsList all available boards in your Monday account | key: listBoards
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Result Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
#
List ItemsGet the information and metadata of an item by Id | key: listItems
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Items string / Required Value List | Notes Provide the unique identifier for each item. | Example 780497 |
Input Result Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
#
List UpdatesList all updates that have been created | key: listUpdates
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Result Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Update Id string / Required | Notes Provide the unique identifier of the update Id. | Example 793400 |
#
Update Column TitleUpdate the title of an existing column | key: updateColumnTitle
Input | Notes | Example |
---|---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board | Example |
Input Column Id string / Required | Notes Provide the Id of the column. | Example status |
Input Column Title string / Required | Notes Provide a string value for the title of the column. | Example Due Date |
Input Connection connection / Required | Notes | Example |
#
Update Column ValueUpdate the given column value | key: updateColumnValue
Input | Notes | Example |
---|---|---|
Input Board Id string / Required | Notes Provide the unique identifier of the board | Example |
Input Column Id string / Required | Notes Provide the Id of the column. | Example status |
Input Column Value string / Required | Notes Provide the value to update the column with. | Example Example Value |
Input Connection connection / Required | Notes | Example |
Input Item Id string / Required | Notes Provide the unique identifier of the item. | Example 098093745 |