Skip to main content

Monday Component

Monday

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.

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.

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:

Actions​

Archive Board​

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

Output Example Payload​

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

Create Board​

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

Output Example Payload​

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

Generic GraphQL Request​

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

Get Board​

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

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 (Deprecated)​

Fetch items that have a certain column value. This version of the action is being deprecated. Please replace action with Get Items By Column Value (Latest) | key: getItemsByColumnValue

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"
          }
        ]
      }
    ]
  }
}

Get Items By Column Value (Latest)​

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

Output Example Payload​

{
  "data": {
    "items_by_column_values": [
      {
        "id": "12345678912",
        "name": "task #1",
        "creator": {
          "email": "example@email.com"
        },
        "updated_at": "2024-02-23T15:23:39Z",
        "state": "active",
        "column_values": [
          {
            "id": "person",
            "text": "John Doe",
            "column": {
              "description": null,
              "title": "Person"
            },
            "type": "people",
            "value": "{\"personsAndTeams\":[{\"id\":12345678,\"kind\":\"person\"}]}"
          },
          {
            "id": "status",
            "text": "Working on it",
            "column": {
              "description": null,
              "title": "Status"
            },
            "type": "status",
            "value": "{\"index\":0,\"post_id\":null,\"changed_at\":\"2019-03-01T17:24:57.321Z\"}"
          },
          {
            "id": "date4",
            "text": "2022-07-12",
            "column": {
              "description": null,
              "title": "Date"
            },
            "type": "date",
            "value": "{\"date\":\"2022-07-12\",\"icon\":null,\"changed_at\":\"2022-07-11T20:27:58.362Z\"}"
          },
          {
            "id": "text",
            "text": "This is a text column",
            "column": {
              "description": null,
              "title": "Text"
            },
            "type": "text",
            "value": "\"This is a text column\""
          },
          {
            "id": "country",
            "text": "United States",
            "column": {
              "description": null,
              "title": "Country"
            },
            "type": "country",
            "value": "{\"changed_at\":\"2024-02-23T15:23:39.043Z\",\"countryCode\":\"US\",\"countryName\":\"United States\"}"
          }
        ]
      }
    ]
  }
}

List Boards​

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

Output Example Payload​

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