MondayClient

Attributes

FieldWorkspace module-attribute

FieldWorkspace = str

FieldBoard module-attribute

FieldBoard = str

FieldColumnsToUpdateSingleColumn module-attribute

FieldColumnsToUpdateSingleColumn = str

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'WebhookCreateItem': {'operation_id': 'WebhookCreateItem', 'path': '/{connectionId}/registerWebhook/CreateItem', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookCreateItemResponse'}, 'WebhookCreateUpdate': {'operation_id': 'WebhookCreateUpdate', 'path': '/{connectionId}/registerWebhook/CreateUpdate', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookCreateUpdateResponse'}, 'WebhookChangeName': {'operation_id': 'WebhookChangeName', 'path': '/{connectionId}/registerWebhook/ChangeName', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookChangeNameResponse'}, 'WebhookChangeSubitemName': {'operation_id': 'WebhookChangeSubitemName', 'path': '/{connectionId}/registerWebhook/ChangeSubitemName', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookChangeSubitemNameResponse'}, 'WebhookCreateSubitem': {'operation_id': 'WebhookCreateSubitem', 'path': '/{connectionId}/registerWebhook/CreateSubitem', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookCreateSubitemResponse'}, 'WebhookColumnChanges': {'operation_id': 'WebhookColumnChanges', 'path': '/{connectionId}/registerWebhook/ColumnChanges', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookColumnChangesResponse'}, 'WebhookAnyColumnChanges': {'operation_id': 'WebhookAnyColumnChanges', 'path': '/{connectionId}/registerWebhook/AnyColumnChanges', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookAnyColumnChangesResponse'}, 'WebhookSubitemColumnChanges': {'operation_id': 'WebhookSubitemColumnChanges', 'path': '/{connectionId}/registerWebhook/SubitemColumnChanges', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookSubitemColumnChangesResponse'}}

Classes

WebhookCreateItemInput dataclass

WebhookCreateItemInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, callback_url: Optional[str] = None)

When an item is created

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

Specify the callback URL

WebhookCreateItemResponse dataclass

WebhookCreateItemResponse(additional_properties: Dict[str, Any] = dict())

Response for When an item is created

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookCreateUpdateInput dataclass

WebhookCreateUpdateInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, callback_url: Optional[str] = None)

When a new update is posted

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookCreateUpdateResponse dataclass

WebhookCreateUpdateResponse(additional_properties: Dict[str, Any] = dict())

Response for When a new update is posted

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookChangeNameInput dataclass

WebhookChangeNameInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, callback_url: Optional[str] = None)

When an item's name changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookChangeNameResponse dataclass

WebhookChangeNameResponse(additional_properties: Dict[str, Any] = dict())

Response for When an item's name changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookChangeSubitemNameInput dataclass

WebhookChangeSubitemNameInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, callback_url: Optional[str] = None)

When a subitem's name changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookChangeSubitemNameResponse dataclass

WebhookChangeSubitemNameResponse(additional_properties: Dict[str, Any] = dict())

Response for When a subitem's name changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookCreateSubitemInput dataclass

WebhookCreateSubitemInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, callback_url: Optional[str] = None)

When a subitem is created

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookCreateSubitemResponse dataclass

WebhookCreateSubitemResponse(additional_properties: Dict[str, Any] = dict())

Response for When a subitem is created

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookColumnChangesInput dataclass

WebhookColumnChangesInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, column_id: Optional[str] = None, callback_url: Optional[str] = None)

When a column changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

column_id class-attribute instance-attribute

column_id: Optional[str] = field(default=None, metadata={'wire_name': 'columnId'})

Select a column from the drop-down.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookColumnChangesResponse dataclass

WebhookColumnChangesResponse(additional_properties: Dict[str, Any] = dict())

Response for When a column changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookAnyColumnChangesInput dataclass

WebhookAnyColumnChangesInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, callback_url: Optional[str] = None)

When any column changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookAnyColumnChangesResponse dataclass

WebhookAnyColumnChangesResponse(additional_properties: Dict[str, Any] = dict())

Response for When any column changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookSubitemColumnChangesInput dataclass

WebhookSubitemColumnChangesInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, callback_url: Optional[str] = None)

When any subitem column changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookSubitemColumnChangesResponse dataclass

WebhookSubitemColumnChangesResponse(additional_properties: Dict[str, Any] = dict())

Response for When any subitem column changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CreateItemInput dataclass

CreateItemInput(workspace_id: Optional[FieldWorkspace] = None, board_id: Optional[FieldBoard] = None, group_id: Optional[str] = None, item_name: Optional[str] = None, column_values: Optional[DynamicResponseGetListSchema] = None)

Create an item

Attributes

group_id class-attribute instance-attribute

group_id: Optional[str] = field(default=None, metadata={'wire_name': 'groupId'})

Select a group from the drop-down or specify a group ID.

item_name class-attribute instance-attribute

item_name: Optional[str] = field(default=None, metadata={'wire_name': 'itemName'})

Specify the name of the item you want to create.

CreateItemResponse dataclass

CreateItemResponse(data: Optional[Dict[str, Any]] = None)

Response for Create an item

DuplicateBoardInput dataclass

DuplicateBoardInput(source_workspace_id: Optional[str] = None, source_board_id: Optional[str] = None, duplicated_board_name: Optional[str] = None, duplication_type: Optional[str] = None, destination_workspace_id: Optional[str] = None, destination_folder: Optional[str] = None, keep_board_subscribers: Optional[bool] = None)

Duplicate a board

Attributes

source_workspace_id class-attribute instance-attribute

source_workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'sourceWorkspaceId'})

Select the workspace for the board you want to duplicate.

source_board_id class-attribute instance-attribute

source_board_id: Optional[str] = field(default=None, metadata={'wire_name': 'sourceBoardId'})

Select the board to duplicate.

duplicated_board_name class-attribute instance-attribute

duplicated_board_name: Optional[str] = field(default=None, metadata={'wire_name': 'duplicatedBoardName'})

Specify the name of the duplicated board.

duplication_type class-attribute instance-attribute

duplication_type: Optional[str] = field(default=None, metadata={'wire_name': 'duplicationType'})

Select the duplication type from the drop-down.

destination_workspace_id class-attribute instance-attribute

destination_workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'destinationWorkspaceId'})

Select the destination workspace for the duplicated board.

destination_folder class-attribute instance-attribute

destination_folder: Optional[str] = field(default=None, metadata={'wire_name': 'destinationFolder'})

Select the destination folder for the duplicated board.

keep_board_subscribers class-attribute instance-attribute

keep_board_subscribers: Optional[bool] = field(default=None, metadata={'wire_name': 'keepBoardSubscribers'})

Select whether to keep board subscribers.

DuplicateBoardResponse dataclass

DuplicateBoardResponse(id: Optional[str] = None)

Response for Duplicate a board

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The ID of the duplicated board

CreateBoardInput dataclass

CreateBoardInput(workspace_id: Optional[str] = None, board_name: Optional[str] = None)

Create a board

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Specify the ID of a monday.com workspace.

board_name class-attribute instance-attribute

board_name: Optional[str] = field(default=None, metadata={'wire_name': 'boardName'})

Specify the desired name of the board you want to create.

CreateBoardResponse dataclass

CreateBoardResponse(data: Optional[Dict[str, Any]] = None)

Response for Create a board

CreateColumnInput dataclass

CreateColumnInput(workspace_id: Optional[FieldWorkspace] = None, board_id: Optional[FieldBoard] = None, title: Optional[str] = None, description: Optional[str] = None, column_type: Optional[str] = None)

Create a column

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

Specify the title of the column you want to create.

description class-attribute instance-attribute

description: Optional[str] = None

Specify the description of the column you want to create.

column_type class-attribute instance-attribute

column_type: Optional[str] = field(default=None, metadata={'wire_name': 'columnType'})

Select a column type from the drop-down.

CreateColumnResponse dataclass

CreateColumnResponse(data: Optional[Dict[str, Any]] = None)

Response for Create a column

CreateGroupInput dataclass

CreateGroupInput(workspace_id: Optional[FieldWorkspace] = None, board_id: Optional[FieldBoard] = None, group_name: Optional[str] = None)

Create a group

Attributes

group_name class-attribute instance-attribute

group_name: Optional[str] = field(default=None, metadata={'wire_name': 'groupName'})

Specify your desired group name.

CreateGroupResponse dataclass

CreateGroupResponse(data: Optional[Dict[str, Any]] = None)

Response for Create a group

UpdateItemColumnInput dataclass

UpdateItemColumnInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, column_id: Optional[FieldColumnsToUpdateSingleColumn] = None, item_id: Optional[str] = None, column_values: Optional[DynamicResponseGetSingleColumnSchema] = None)

Update an item's column value

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select the workspace the item belongs to from the drop-down.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select the board the item belongs to from the drop-down.

item_id class-attribute instance-attribute

item_id: Optional[str] = field(default=None, metadata={'wire_name': 'itemId'})

Specify the ID of the item to update.

UpdateItemColumnResponse dataclass

UpdateItemColumnResponse(data: Optional[Dict[str, Any]] = None)

Response for Update an item's column value

UpdateMultipleItemColumnsInput dataclass

UpdateMultipleItemColumnsInput(workspace_id: Optional[str] = None, board_id: Optional[str] = None, item_id: Optional[str] = None, item_name: Optional[str] = None, column_values: Optional[DynamicResponseGetListSchema] = None)

Update multiple item column values

Attributes

workspace_id class-attribute instance-attribute

workspace_id: Optional[str] = field(default=None, metadata={'wire_name': 'workspaceId'})

Select the workspace the item belongs to from the drop-down.

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select the board the item belongs to from the drop-down.

item_id class-attribute instance-attribute

item_id: Optional[str] = field(default=None, metadata={'wire_name': 'itemId'})

Specify the ID of the item to update.

item_name class-attribute instance-attribute

item_name: Optional[str] = field(default=None, metadata={'wire_name': 'itemName'})

Specify a new name for the item. Leave blank to keep the current name.

UpdateMultipleItemColumnsResponse dataclass

UpdateMultipleItemColumnsResponse(data: Optional[Dict[str, Any]] = None)

Response for Update multiple item column values

MoveItemToGroupInput dataclass

MoveItemToGroupInput(workspace_id: Optional[FieldWorkspace] = None, board_id: Optional[FieldBoard] = None, group_id: Optional[str] = None, item_id: Optional[str] = None)

Move an item to a group

Attributes

group_id class-attribute instance-attribute

group_id: Optional[str] = field(default=None, metadata={'wire_name': 'groupId'})

Select the group to move the item to from the drop-down.

item_id class-attribute instance-attribute

item_id: Optional[str] = field(default=None, metadata={'wire_name': 'itemId'})

Specify the ID of the item to move.

MoveItemToGroupResponse dataclass

MoveItemToGroupResponse(data: Optional[Dict[str, Any]] = None)

Response for Move an item to a group

CreateNotificationInput dataclass

CreateNotificationInput(user_id: Optional[str] = None, target_id: Optional[str] = None, text: Optional[str] = None)

Create a notification

Attributes

user_id class-attribute instance-attribute

user_id: Optional[str] = field(default=None, metadata={'wire_name': 'userId'})

Select a user from the drop-down or specify a user ID.

target_id class-attribute instance-attribute

target_id: Optional[str] = field(default=None, metadata={'wire_name': 'targetId'})

Specify a board ID or item ID the notification will go to.

text class-attribute instance-attribute

text: Optional[str] = None

Specify the notification text.

CreateNotificationResponse dataclass

CreateNotificationResponse(data: Optional[Dict[str, Any]] = None)

Response for Create a notification

Attributes

data class-attribute instance-attribute

data: Optional[Dict[str, Any]] = None

Data

CreateSubitemInput dataclass

CreateSubitemInput(workspace_id: Optional[FieldWorkspace] = None, board_id: Optional[str] = None, parent_item_id: Optional[str] = None, item_name: Optional[str] = None, column_values: Optional[DynamicResponseGetListSchema] = None)

Create a subitem

Attributes

board_id class-attribute instance-attribute

board_id: Optional[str] = field(default=None, metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

parent_item_id class-attribute instance-attribute

parent_item_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentItemId'})

Select a parent item from the drop-down or specify a parent item ID.

item_name class-attribute instance-attribute

item_name: Optional[str] = field(default=None, metadata={'wire_name': 'itemName'})

Specify a name for the subitem.

CreateSubitemResponse dataclass

CreateSubitemResponse(data: Optional[Dict[str, Any]] = None)

Response for Create a subitem

GetSubitemColumnNamesForGetSubitems dataclass

GetSubitemColumnNamesForGetSubitems(additional_properties: Dict[str, Any] = dict())

Response for Get subitems

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CreateUpdateInput dataclass

CreateUpdateInput(workspace_id: Optional[FieldWorkspace] = None, board_id: Optional[FieldBoard] = None, group_id: Optional[str] = None, item_id: Optional[str] = None, body: Optional[str] = None)

Create an update

Attributes

group_id class-attribute instance-attribute

group_id: Optional[str] = field(default=None, metadata={'wire_name': 'groupId'})

Select a group from the drop-down or specify a group ID.

item_id class-attribute instance-attribute

item_id: Optional[str] = field(default=None, metadata={'wire_name': 'itemId'})

Select an item from the drop-down or specify an item ID.

body class-attribute instance-attribute

body: Optional[str] = None

Specify text for the update.

CreateUpdateResponse dataclass

CreateUpdateResponse(data: Optional[Dict[str, Any]] = None)

Response for Create an update

DynamicResponseGetListSchemaGet dataclass

DynamicResponseGetListSchemaGet(additional_properties: Dict[str, Any] = dict())

Response for Get an item by ID

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CreateWorkspaceInput dataclass

CreateWorkspaceInput(name: Optional[str] = None, description: Optional[str] = None)

Create a workspace

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Specify a name for the new workspace.

description class-attribute instance-attribute

description: Optional[str] = None

Specify a description for the new workspace.

CreateWorkspaceResponse dataclass

CreateWorkspaceResponse(data: Optional[Dict[str, Any]] = None)

Response for Create a workspace

DynamicGetGetItemsSchema dataclass

DynamicGetGetItemsSchema(additional_properties: Dict[str, Any] = dict())

Response for Get items

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetTagsResponse dataclass

GetTagsResponse(data: Optional[Dict[str, Any]] = None)

Response for Get tags

GetUsersResponse dataclass

GetUsersResponse(data: Optional[Dict[str, Any]] = None)

Response for Get users

GetWorkspacesResponse dataclass

GetWorkspacesResponse(data: Optional[Dict[str, Any]] = None)

Response for Get workspaces

Attributes

data class-attribute instance-attribute

data: Optional[Dict[str, Any]] = None

data

GetColumnNamesSchemaResponse dataclass

GetColumnNamesSchemaResponse(schema: Optional[Dict[str, Any]] = None)

Response for Get column names for a board ID

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

GetSingleColumnSchemaResponse dataclass

GetSingleColumnSchemaResponse(schema: Optional[Dict[str, Any]] = None)

Response for Gets single column schema for a board ID

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

GetColumnNamesSchemaForWebhookResponse dataclass

GetColumnNamesSchemaForWebhookResponse(schema: Optional[Dict[str, Any]] = None)

Response for Get column names for a board ID for a webhook

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

GetSchemaForGetItemsActionResponse dataclass

GetSchemaForGetItemsActionResponse(schema: Optional[Dict[str, Any]] = None)

Response for Get column names for a board ID for a webhook

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

GetColumnNamesSchemaForUpdateWebhookResponse dataclass

GetColumnNamesSchemaForUpdateWebhookResponse(schema: Optional[Dict[str, Any]] = None)

Response for Get column names for a board ID for an update webhook

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

GetSubitemColumnNamesResponse dataclass

GetSubitemColumnNamesResponse(schema: Optional[Dict[str, Any]] = None)

Response for Get subitem column names

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

GetSubitemSchemaResponse dataclass

GetSubitemSchemaResponse(schema: Optional[Dict[str, Any]] = None)

Response for Get subitem column names

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

GetColumnNamesSchemaForItemNameChangeWebhookResponse dataclass

GetColumnNamesSchemaForItemNameChangeWebhookResponse(schema: Optional[Dict[str, Any]] = None)

Response for Get column names schema for column changes

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

GetColumnNamesSchemaForSubitemNameChangeWebhookResponse dataclass

GetColumnNamesSchemaForSubitemNameChangeWebhookResponse(schema: Optional[Dict[str, Any]] = None)

Response for Get column names schema for column changes

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

GetColumnNamesSchemaForColumnChangesWebhookResponse dataclass

GetColumnNamesSchemaForColumnChangesWebhookResponse(schema: Optional[Dict[str, Any]] = None)

Response for Get column names schema for column changes

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = None

Schema of the requested schema type

DynamicResponseGetListSchema dataclass

DynamicResponseGetListSchema(additional_properties: Dict[str, Any] = dict())

Definition: DynamicResponseGetListSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicResponseGetSingleColumnSchema dataclass

DynamicResponseGetSingleColumnSchema(additional_properties: Dict[str, Any] = dict())

Definition: DynamicResponseGetSingleColumnSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicGetColumnNamesForWebhook dataclass

DynamicGetColumnNamesForWebhook(additional_properties: Dict[str, Any] = dict())

Definition: DynamicGetColumnNamesForWebhook

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicGetColumnNamesForUpdateWebhook dataclass

DynamicGetColumnNamesForUpdateWebhook(additional_properties: Dict[str, Any] = dict())

Definition: DynamicGetColumnNamesForUpdateWebhook

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicGetSubitemColumnNamesForWebhook dataclass

DynamicGetSubitemColumnNamesForWebhook(additional_properties: Dict[str, Any] = dict())

Definition: DynamicGetSubitemColumnNamesForWebhook

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

MondayClient

MondayClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for monday connector.

Initialize a MondayClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

create_item_async async

create_item_async(input: CreateItemInput) -> dict[str, Any] | None

Create an item

Creates an item in the selected monday.com board and group.

duplicate_board_async async

duplicate_board_async(input: DuplicateBoardInput) -> dict[str, Any] | None

Duplicate a board

Duplicates a board in monday.com.

create_board_async async

create_board_async(input: CreateBoardInput) -> dict[str, Any] | None

Create a board

Creates a board in monday.com.

create_column_async async

create_column_async(input: CreateColumnInput) -> dict[str, Any] | None

Create a column

Creates a column in monday.com for the specified board.

create_group_async async

create_group_async(input: CreateGroupInput) -> dict[str, Any] | None

Create a group

Creates a group in monday.com for the specified board.

update_item_column_async async

update_item_column_async(input: UpdateItemColumnInput) -> dict[str, Any] | None

Update an item's column value

Updates a single item's column. If the value is blank, the column value will be cleared.

update_multiple_item_columns_async async

update_multiple_item_columns_async(input: UpdateMultipleItemColumnsInput) -> dict[str, Any] | None

Update multiple item column values

Updates multiple item columns. Leave the column value blank to keep the current value.

move_item_to_group_async async

move_item_to_group_async(input: MoveItemToGroupInput) -> dict[str, Any] | None

Move an item to a group

Moves an item to another group on the same board.

create_notification_async async

create_notification_async(input: CreateNotificationInput) -> dict[str, Any] | None

Create a notification

Creates a notification in monday.com for a user for either a specific board or item.

create_subitem_async async

create_subitem_async(input: CreateSubitemInput) -> dict[str, Any] | None

Create a subitem

Creates a subitem in monday.com for the selected board and parent item.

get_subitems_async async

get_subitems_async(workspace_id: str, board_id: str, item_id: str) -> dict[str, Any] | None

Get subitems

Gets subitems in monday.com for a specific item in a board.

create_update_async async

create_update_async(input: CreateUpdateInput) -> dict[str, Any] | None

Create an update

Creates an update in monday.com for a specific item.

get_item_by_id_async async

get_item_by_id_async(item_id: str, workspace_id: str, board_id: str) -> dict[str, Any] | None

Get an item by ID

Gets a monday.com item using the specified item ID and board.

create_workspace_async async

create_workspace_async(input: CreateWorkspaceInput) -> dict[str, Any] | None

Create a workspace

Creates a monday.com workspace with a user-specified name and description.

get_items_async async

get_items_async(workspace_id: str, board_id: str, group_id: str, filter1_column: Optional[str] = None, filter1_operator: Optional[str] = None, filter1_value: Optional[str] = None, filter2_column: Optional[str] = None, filter2_operator: Optional[str] = None, filter2_value: Optional[str] = None, filter3_column: Optional[str] = None, filter3_operator: Optional[str] = None, filter3_value: Optional[str] = None, filter4_column: Optional[str] = None, filter4_operator: Optional[str] = None, filter4_value: Optional[str] = None) -> dict[str, Any] | None

Get items

Gets items in monday.com for a specific board and group. Filter items by column values using the filters found under advanced options. More info on filtering can be found here: https://plugingenie.com/docs/filtering-items.

get_tags_async async

get_tags_async() -> dict[str, Any] | None

Get tags

This operation gets monday.com tags.

get_users_async async

get_users_async() -> dict[str, Any] | None

Get users

This operation gets the name, email, and ID of users in your monday.com account.

get_workspaces_async async

get_workspaces_async() -> dict[str, Any] | None

Get workspaces

This operation gets the workspaces from monday.com.

get_boards_async async

get_boards_async(workspace_id: Optional[str] = None) -> dict[str, Any] | None

Get boards

This operation gets the boards from monday.com.

get_groups_for_get_items_async async

get_groups_for_get_items_async(board_id: str) -> dict[str, Any] | None

Get groups for the Get Items operation

This operation gets the groups from monday.com, which includes the option to select all groups.

get_columns_for_item_filtering_async async

get_columns_for_item_filtering_async(board_id: str) -> dict[str, Any] | None

Get columns for item filtering

This operation gets the columns from monday.com for item filtering.

get_column_filter_operator_async async

get_column_filter_operator_async(board_id: str, column_id: Optional[str] = None) -> dict[str, Any] | None

Get column filter operator

This operation gets the available item filter operator for the selected monday.com column.

get_column_names_schema_async async

get_column_names_schema_async(board_id: Optional[str] = None) -> dict[str, Any] | None

Get column names for a board ID

This operation gets the column names for a board ID.

get_single_column_schema_async async

get_single_column_schema_async(board_id: Optional[str] = None, column_id: Optional[str] = None) -> dict[str, Any] | None

Gets single column schema for a board ID

This operation gets the single column schema for a board ID.

get_column_names_schema_for_webhook_async async

get_column_names_schema_for_webhook_async(board_id: Optional[str] = None) -> dict[str, Any] | None

Get column names for a board ID for a webhook

This operation gets the column names for a board ID for a webhook (includes itemId).

get_schema_for_get_items_action_async async

get_schema_for_get_items_action_async(board_id: Optional[str] = None) -> dict[str, Any] | None

Get column names for a board ID for a webhook

This operation gets the schema for the GetItems action.

get_column_names_schema_for_update_webhook_async async

get_column_names_schema_for_update_webhook_async(board_id: Optional[str] = None) -> dict[str, Any] | None

Get column names for a board ID for an update webhook

This operation gets the column names for a board ID for a webhook (includes itemId).

get_subitem_column_names_async async

get_subitem_column_names_async(parent_board_id: str) -> dict[str, Any] | None

Get subitem column names

Gets subitem column names in monday.com given a board ID.

get_subitem_schema_async async

get_subitem_schema_async(parent_board_id: str) -> dict[str, Any] | None

Get subitem column names

Gets subitem schema in monday.com given a board ID.

get_column_names_schema_for_item_name_change_webhook_async async

get_column_names_schema_for_item_name_change_webhook_async(board_id: Optional[str] = None) -> dict[str, Any] | None

Get column names schema for column changes

This operation gets the column names for a board ID for a webhook when the item's name changes.

get_column_names_schema_for_subitem_name_change_webhook_async async

get_column_names_schema_for_subitem_name_change_webhook_async(parent_board_id: str) -> dict[str, Any] | None

Get column names schema for column changes

This operation gets the column names for a board ID for a webhook when the subitem's name changes.

get_column_names_schema_for_column_changes_webhook_async async

get_column_names_schema_for_column_changes_webhook_async(board_id: Optional[str] = None) -> dict[str, Any] | None

Get column names schema for column changes

This operation gets the column names for a board ID for a webhook (includes itemId).