proclame/tblack-it-monday-api

Monday v2 API developed by TBLACK-IT

v0.2.5 2023-12-27 11:26 UTC

Requires

• php: >=7.0
• ext-json: *

LGPL-2.1-only

• Pedro Teixeira

README

Monday.com API

Installation & loading

Monday API is available on Packagist (using semantic versioning), and installation via Composer is the recommended way to install Monday API. Just add this line to your composer.json file:

"tblack-it/monday-api": "~0.2"

or run

composer require tblack-it/monday-api

Note that the vendor folder and the vendor/autoload.php script are generated by Composer; they are not part of Monday API

Examples

Init Monday connector

<?php

require 'vendor/autoload.php';

$token = 'API_TOKEN';
$MondayBoard = new TBlack\MondayAPI\MondayBoard();
$MondayBoard->setToken(new TBlack\MondayAPI\Token($token));

Interact with boards

# Get all boards
$all_boards = $MondayBoard->getBoards();

# Get Board id : 10012
$board_id = 10012;
$board = $MondayBoard->on($board_id)->getBoards();

# Get Board Columns
$board_id = 10012;
$boardColumns = $MondayBoard->on($board_id)->getColumns();

# Create Board, if success return board_id
$newboard = $MondayBoard->create( 'New Board Name', TBlack\MondayAPI\ObjectTypes\BoardKind::PUB );
$board_id = $newboard['create_board']['id'];

Interact with Itens

# Insert new Item on Board
$board_id = 10012;
$id_group = 'topics';
$column_values = [ 'text1' => 'Value...','text2' => 'Other value...' ];

$addResult = $MondayBoard
              ->on($board_id)
              ->group($id_group)
              ->addItem( 'My Item Title', $column_values );

# If you want to use the `create_labels_if_missing` arguments; just add `true` as the third arguments (default: `false`)
$addResult = $MondayBoard
              ->on($board_id)
              ->group($id_group)
              ->addItem( 'My Item Title', $column_values, true);

# if succes return
$item_id = $addResult['create_item']['id'];

# For update Item
$item_id = 34112;
$column_values = [ 'text1' => 'New Value','text2' => 'New other value...' ];

$updateResult = $MondayBoard
              ->on($board_id)
              ->group($id_group)
              ->changeMultipleColumnValues($item_id, $column_values );

# Archive item
$result = $MondayBoard
              ->on($board_id)
              ->group($id_group)
              ->archiveItem($item_id);

// Delete item
$result = $MondayBoard
              ->on($board_id)
              ->group($id_group)
              ->deleteItem($item_id);

If you need specific action, you can run a custom Query or Mutation

// Run a custom query
$query = '
boards (ids: 12121212) {
  groups (ids: group_id) {
    items {
      id
      name
      column_values {
        id
        text
        title
      }
    }
  }
}';

# For Query
$items = $MondayBoard->customQuery( $query );

# For Mutation
$items = $MondayBoard->customMutation( $query );

To get the error message

$error = $MondayBoard->error;