Managed API for monday.com

Managed API for monday.com is an API Client for monday.com by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.

This is a runtime agnostic version of the Managed API (with core suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.

Platform specific ports

• ScriptRunner Connect

Supported API calls

• fetch
• Board
  • archiveBoard
  • createBoard
  • deleteBoard
  • deleteSubscribersFromBoard
  • duplicateBoard
  • getBoards
  • updateBoard
  • View
    • getViews
  • Group
    • getGroups
    • createGroup
    • updateGroup
    • duplicateGroup
    • archiveGroup
    • deleteGroup
  • ItemsPage
    • getItemsPage
  • Tag
    • getTags
• Column
  • changeColumnMetadata
  • changeColumnTitle
  • changeColumnValue
  • changeMultipleColumnValues
  • changeSimpleColumnValue
  • createColumn
  • deleteColumn
• File
  • addFileToColumn
  • addFileToUpdate
  • getAssets
• Item
  • archiveItem
  • clearUpdates
  • createItem
  • deleteItem
  • duplicateItem
  • getItems
  • moveItemToGroup
  • moveItemToBoard
  • Subitem
    • createSubitem
    • getSubitems
• ItemsPage
  • getNextItemsPage
  • getItemsPageByColumnValues
• Me
  • getUserDetails
• Notification
  • createNotification
• Team
  • getTeams
  • addTeamsToBoard
  • addTeamsToWorkspace
  • deleteTeamsFromWorkspace
  • deleteTeamsFromBoard
  • addUsersToTeam
  • removeUsersFromTeam
  • createTeam
  • deleteTeam
• User
  • addUsersToBoard
  • addUsersToWorkspace
  • deleteUsersFromWorkspace
  • getUsers
• Workspace
  • createWorkspace
  • updateWorkspace
  • deleteWorkspace
  • getWorkspaces
• Folder
  • getFolders
  • createFolder
  • updateFolder
  • deleteFolder
• Update
  • getUpdates
  • createUpdate
  • likeUpdate
  • unlikeUpdate
  • editUpdate
  • pinUpdate
  • unpinUpdate
  • deleteUpdate
• Doc
  • getDocs
  • createDoc
  • DocBlock
    • getDocBlocks
    • createDocBlock
    • updateDocBlock
    • deleteDocBlock
• Tag
  • getTags
  • createOrGetTag
• Version
  • getVersion
  • getVersions
• Webhook
  • getWebhooks
  • createWebhook
  • deleteWebhook

Porting to other runtimes

While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.

You can do so by extending the *Core Managed API class where you'll be asked to provide implementation for getPlatformImplementation function. In this implementation you have yo specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:

{
    buffer: {
        encode(input: string): ArrayBuffer;
        decode(input: ArrayBuffer): string;
    },
    performHttpCall(request: Request): Promise<Response>
}

Here is an example how to create a Node port of the Managed API:

import { MondayApiCore } from "@managed-api/monday-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";

export class MondayApi extends MondayApiCore {
    constructor(private baseUrl: string, private authToken: string) {
        super();
    }

    protected getPlatformImplementation(): PlatformImplementation {
        return {
            buffer: {
                encode: (input) => Buffer.from(input, 'utf-8'),
                decode: (input) => Buffer.from(input).toString('utf-8')
            },
            performHttpCall: (request) => this.performHttpCall(request)
        };
    }

    private async performHttpCall(request: Request): Promise<Response> {
        const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
        request.headers.set('Authorization', `Basic ${this.authToken}`); // Substitute auth token
        const response = await fetch(requestUrl, {
            method: request.method,
            headers: request.headers as any,
            body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
        });

        const apiHeaders = new Headers();
        response.headers.forEach((value, key) => apiHeaders.append(key, value));

        const body = await response.arrayBuffer();

        return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
    }
}

Please note that the authentication handling details may not be accurate and serve as an example. If you wish yo use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.

Contact

At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to [email protected] for ideas, suggestions and improvements.

Changelog

2025-01

• New updates fields:

  • edited_at: Returns the date the update's body was last edited.
  • viewers: Returns data about the update's viewers.

• The item_id argument on the pin_to_top and unpin_from_top mutations has changed from type Int to ID and is no longer required.

• Added new methods:

  • createTeam
  • deleteTeam

  Check out the full announcement

Copyright Adaptavist 2024 (c) All rights reserved