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.
- fetch
- Board
- Column
- File
- Item
- ItemsPage
- Me
- Notification
- Team
- User
- Workspace
- Folder
- Update
- Doc
- Tag
- Version
- Webhook
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.
At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to eknoll@adaptavist.com for ideas, suggestions and improvements.
- Updated development setup instructions
- Pass
update_idasIDinUpdate.likeUpdate.
- Add build script for local development and testing.
- Fix issue where
column_value.columnwas incorrectly labelled as an array.
- Add missing type options related to nested
items_page. - Pass API version down to nested types.
- Update
Groupqueries and mutations to return anitems_pageinstead ofitems.
- Fix
getWebhooksresponse.
- Add
is_default_workspacefield toworkspacequeries.
- Add
relative_toandposition_relative_methodtoItem.createItem.
- Add
display_namefield toversionqueries. - Update
kindenum values inversionqueries.
- Convert id arguments in all managed APIs to use
IDtype. - Add missing
after_column_idarg toColumn.createColumn. - Fix return type of
item.id.
- Update common cores package to version
0.3.14.
-
-
addUsersToTeam that can be used as
Team.addUsersToTeamorAll.addUsersToTeam. -
removeUsersFromTeam that can be used as
Team.removeUsersFromTeamorAll.removeUsersFromTeam.
-
addUsersToTeam that can be used as
-
-
updateWorkspace that can be used as
Workspace.updateWorkspaceorAll.updateWorkspace
-
updateWorkspace that can be used as
- Support
votersfield in VoteValue fragment.
- Support for
group_colorargument in createGroup.
- Support version 2024-04 of Monday API.
- Support
urlfield in boards and items.
-
-
deleteTeamsFromBoard that can be used as
Team.deleteTeamsFromBoardorAll.deleteTeamsFromBoard.
-
deleteTeamsFromBoard that can be used as
- Implement remaining column value fragments.
- Fixing response objects for ItemsPage.getItemsPage.
- Allow access to
__typenamefield in returned GraphQL objects.
- Fix issue with
items_pagemanaged API preventing Monday from acceptingquery_paramsarguments.
- Support for StatusValue and TimelineValue fragments.
- Support for complexity queries to monitor the cost of each operation you make
- Using api version 2023-10 as default. Removing support for 2023-07
-
-
getFolders that can be used as
Folder.getFoldersorAll.getFolders -
createFolder that can be used as
Folder.createFolderorAll.createFolder -
updateFolder that can be used as
Folder.updateFolderorAll.updateFolder -
deleteFolder that can be used as
Folder.deleteFolderorAll.deleteFolder
-
getFolders that can be used as
- Converted all enum types to union types, for easier autocompletion suggestions
-
-
getWebhooks that can be used as
Webhook.getWebhooksorAll.getWebhooks -
createWebhook that can be used as
Webhook.createWebhookorAll.createWebhook -
deleteWebhook that can be used as
Webhook.deleteWebhookorAll.deleteWebhook
-
getWebhooks that can be used as
-
-
getVersion that can be used as
Version.getVersionorAll.getVersion -
getVersions that can be used as
Version.getVersionsorAll.getVersions
-
getVersion that can be used as
-
-
getTags that can be used as
Tag.getTagsorAll.getTags -
getTags that can be used as
Board.Tag.getTags -
createOrGetTag that can be used as
Tag.createOrGetTagorAll.createOrGetTag
-
getTags that can be used as
-
-
getDocBlocks that can be used as
Doc.DocBlock.getDocBlocksorAll.getDocBlocks -
createDocBlock that can be used as
Doc.DocBlock.createDocBlockorAll.createDocBlock -
updateDocBlock that can be used as
Doc.DocBlock.updateDocBlockorAll.updateDocBlock -
deleteDocBlock that can be used as
Doc.DocBlock.deleteDocBlockorAll.deleteDocBlock
-
getDocBlocks that can be used as
-
-
getItemsPage that can be used as
Board.ItemsPage.getItemsPageorAll.getItemsPage -
getNextItemsPage that can be used as
Board.getNextItemsPageorAll.getNextItemsPage -
getItemsPageByColumnValues that can be used as
Board.getItemsPageByColumnValuesorAll.getItemsPageByColumnValues
-
getItemsPage that can be used as
-
-
getTeams that can be used as
Team.getTeamsorAll.getTeams -
addTeamsToBoard that can be used as
Team.addTeamsToBoardorAll.addTeamsToBoard -
addTeamsToWorkspace that can be used as
Team.addTeamsToWorkspaceorAll.addTeamsToWorkspace -
deleteTeamsFromWorkspace that can be used as
Team.deleteTeamsFromWorkspaceorAll.deleteTeamsFromWorkspace
-
getTeams that can be used as
-
-
getUpdates that can be used as
Update.getUpdatesorAll.getUpdates. -
createUpdate that can be used as
Update.createUpdateorAll.createUpdate. -
likeUpdate that can be used as
Update.likeUpdateorAll.likeUpdate. -
deleteUpdate that can be used as
Update.deleteUpdateorAll.deleteUpdate.
-
getUpdates that can be used as
-
-
moveItemToBoard that can be used as
Item.moveItemToBoardorAll.moveItemToBoard.
-
moveItemToBoard that can be used as
-
-
updateGroup that can be used as
Board.Group.updateGrouporAll.updateGroup. -
archiveGroup that can be used as
Board.Group.archiveGrouporAll.archiveGroup. -
duplicateGroup that can be used as
Board.Group.duplicateGrouporAll.duplicateGroup. -
deleteGroup that can be used as
Board.Group.deleteGrouporAll.deleteGroup.
-
updateGroup that can be used as
-
-
createGroup that can be used as
Board.Group.createGrouporAll.createGroup.
-
createGroup that can be used as
-
-
createWorkspace that can be used as
Workspace.createWorkspaceorAll.createWorkspace. -
deleteWorkspace that can be used as
Workspace.deleteWorkspaceorAll.deleteWorkspace. -
getWorkspaces that can be used as
Workspace.getWorkspacesorAll.getWorkspaces.
-
createWorkspace that can be used as
-
-
createNotification that can be used as
Notification.createNotificationorAll.createNotification.
-
createNotification that can be used as
- Changed type from
number[]tostring[]ofidsfield ingroupsarguments for Board fields.
-
-
changeColumnMetadata that can be used as
Column.changeColumnMetadataorAll.changeColumnMetadata. -
changeColumnTitle that can be used as
Column.changeColumnTitleorAll.changeColumnTitle. -
changeColumnValue that can be used as
Column.changeColumnValueorAll.changeColumnValue. -
changeMultipleColumnValues that can be used as
Column.changeMultipleColumnValuesorAll.changeMultipleColumnValues. -
changeSimpleColumnValue that can be used as
Column.changeSimpleColumnValueorAll.changeSimpleColumnValue. -
createColumn that can be used as
Column.createColumnorAll.createColumn. -
deleteColumn that can be used as
Column.deleteColumnorAll.deleteColumn.
-
changeColumnMetadata that can be used as
-
-
archiveBoard that can be used as
Board.archiveBoardorAll.archiveBoard. -
createBoard that can be used as
Board.createBoardorAll.createBoard. -
deleteBoard that can be used as
Board.deleteBoardorAll.deleteBoard. -
deleteSubscribersFromBoard that can be used as
Board.deleteSubscribersFromBoardorAll.deleteSubscribersFromBoard. -
duplicateBoard that can be used as
Board.duplicateBoardorAll.duplicateBoard. -
getBoards that can be used as
Board.getBoardsorAll.getBoards. -
updateBoard that can be used as
Board.updateBoardorAll.updateBoard.
-
archiveBoard that can be used as
-
-
getViews that can be used as
Board.View.getViewsorAll.getBoardViews.
-
getViews that can be used as
-
-
addFileToColumn that can be used as
File.addFileToColumnorAll.addFileToColumn. -
addFileToUpdate that can be used as
File.addFileToUpdateorAll.addFileToUpdate. -
getAssets that can be used as
File.getAssetsorAll.getAssets.
-
addFileToColumn that can be used as
-
-
archiveItem that can be used as
Item.archiveItemorAll.archiveItem. -
clearUpdates that can be used as
Item.clearUpdatesorAll.clearItemUpdates. -
createItem that can be used as
Item.createItemorAll.createItem. -
deleteItem that can be used as
Item.deleteItemorAll.deleteItem. -
duplicateItem that can be used as
Item.duplicateItemorAll.duplicateItem. -
getItems that can be used as
Item.getItemsorAll.getItems. -
moveItemToGroup that can be used as
Item.moveItemToGrouporAll.moveItemToGroup.
-
archiveItem that can be used as
-
-
createSubitem that can be used as
Item.Subitem.createSubitemorAll.createSubitem. -
getSubitems that can be used as
Item.Subitem.getSubitemsorAll.getSubitems.
-
createSubitem that can be used as
-
-
getUserDetails that can be used as
Me.getUserDetailsorAll.getUserDetails.
-
getUserDetails that can be used as
-
-
addUsersToBoard that can be used as
User.addUsersToBoardorAll.addUsersToBoard. -
addUsersToWorkspace that can be used as
User.addUsersToWorkspaceorAll.addUsersToWorkspace. -
deleteUsersFromWorkspace that can be used as
User.deleteUsersFromWorkspaceorAll.deleteUsersFromWorkspace. -
getUsers that can be used as
User.getUsersorAll.getUsers.
-
addUsersToBoard that can be used as
Copyright Adaptavist 2023 (c) All rights reserved