Skip to main content

Monday Component

Manage boards, tasks and workflows within Monday.

Component key: monday

Description#

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.

Monday offers a GraphQL-based API. This gives you flexibility and control over what data you send to Monday, and what data you request back.

While this component offers some actions that wrap common GraphQL queries and mutations, there are many more queries and mutations for which there aren't dedicated actions. If you'd like to run a query or mutation that is not represented by an action, please use the Generic Request action.

Monday Connections#

API Key#

For testing purposes, you can use 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. We recommend using OAuth when you deploy your integration to customers.

InputNotes
Input
API Key
string
/ Required
apiKey
Notes
API Key

OAuth 2.0#

To 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:

InputDefaultNotesExample
Input
Authorize URL
string
/ Required
Hidden Field
authorizeUrl
Default
https://auth.monday.com/oauth2/authorize
Notes
The OAuth 2.0 Authorization URL for Monday
Example
 
Input
Client ID
string
/ Required
clientId
Default
Notes
Client Identifier of your app for Monday
Example
 
Input
Client Secret
password
/ Required
clientSecret
Default
Notes
Client Secret of your app for Monday
Example
 
Input
Scopes
string
scopes
Default
account:read assets:read boards:read boards:write me:read notifications:write tags:read teams:read updates:read updates:write users:read users:write webhooks:write workspaces:read workspaces:write
Notes
Space separated OAuth 2.0 permission scopes for Monday. See https://developer.monday.com/apps/docs/oauth#set-up-permission-scopes.
Example
me:read boards:read
Input
Token URL
string
/ Required
Hidden Field
tokenUrl
Default
https://auth.monday.com/oauth2/token
Notes
The OAuth 2.0 Token URL for Monday
Example
 

Actions#

Archive Board#

Delete the information and metadata of a board by Id | key: archiveBoard

InputNotes
Input
Board ID
string
/ Required
boardId
Notes
Provide the unique identifier of the board
Input
Connection
connection
/ Required
connection
Notes
 

Output Example Payload#

{  "data": {    "archive_board": {      "id": "4277545378"    }  }}

Create Board#

Create a new board inside your Monday account | key: createBoard

InputNotesExample
Input
Board Kind
string
/ Required
boardKind
Notes
Provide a string value for the kind of board.
Example
public
Input
Board Name
string
/ Required
boardName
Notes
Provide a string value for the name of the board.
Example
 
Input
Connection
connection
/ Required
connection
Notes
 
Example
 
Input
Folder ID
string
folderId
Notes
Provide the unique identifier of the folder.
Example
 
Input
Template ID
string
templateId
Notes
Provide the unique identifier of the template that your board extends.
Example
 
Input
Workspace ID
string
workspaceId
Notes
Provide the unique identifier of the workspace.
Example
 

Output Example Payload#

{  "data": {    "create_board": {      "id": "4277545378"    }  }}

Generic GraphQL Request#

Issue any GraphQL query or mutation with variables | key: genericRequest

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Query or Mutation
code
/ Required
query
Default
{  me {    id    email  }}
Notes
 
Input
Variables
string
Key Value List
variables
Default
Notes
 
Input
Variables Object
code
variablesObject
Default
Notes
 

Get Board#

Get the information and metadata of a board by ID | key: getBoard

InputNotes
Input
Board ID
string
/ Required
boardId
Notes
Provide the unique identifier of the board
Input
Connection
connection
/ Required
connection
Notes
 

Output Example Payload#

{  "data": {    "boards": [      {        "id": "2924980809",        "name": "H2 Kickoff",        "state": "active",        "board_folder_id": null,        "columns": [          {            "title": "Name",            "type": "name"          },          {            "title": "Person",            "type": "multiple-person"          },          {            "title": "Status",            "type": "color"          },          {            "title": "Date",            "type": "date"          }        ],        "creator": {          "id": 32002207        }      }    ]  }}

Get Items By Column Value#

Fetch items that have a certain column value | key: getItemsByColumnValue

InputNotesExample
Input
Board ID
string
/ Required
boardId
Notes
Provide the unique identifier of the board
Example
 
Input
Column ID
string
/ Required
columnId
Notes
Provide the ID of the column.
Example
status
Input
Column Value
string
/ Required
columnValue
Notes
The column's value to search items by
Example
 
Input
Connection
connection
/ Required
connection
Notes
 
Example
 

Output Example Payload#

{  "data": {    "items_by_column_values": [      {        "id": "4277581981",        "name": "Task 1",        "creator": {          "email": "example@email.com"        },        "updated_at": "2023-04-10T16:23:17Z",        "state": "active",        "column_values": [          {            "id": "numbers",            "text": "1234",            "title": "Some Numbers",            "value": "\"1234\"",            "description": null,            "type": "numeric"          },          {            "id": "item_id",            "text": "4277581981",            "title": "Item ID",            "value": null,            "description": null,            "type": "pulse-id"          },          {            "id": "text",            "text": "Hi There",            "title": "Text",            "value": "\"Hi There\"",            "description": null,            "type": "text"          }        ]      }    ]  }}

List Boards#

List all available boards in your Monday account | key: listBoards

InputNotesExample
Input
Connection
connection
/ Required
connection
Notes
 
Example
 
Input
Result Limit
string
limit
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
page
Notes
Provide an integer value for the page offset for the given object's results.
Example
3

Output Example Payload#

{  "data": {    "boards": [      {        "id": "2924980809",        "name": "Example Board",        "state": "active",        "board_folder_id": null,        "creator": {          "id": 32002207        }      }    ]  }}