New Task Card: Overview of Changes

The new task card moved comments to the task chat. This page helps you choose the current REST methods for working with comments, files, events, results, and widgets after switching to the new card.

The changes are available starting from module version tasks 25.700.0. The old task methods continue to work, except for comment operations, which are now performed through chat methods.

When to Use This PageWhen to Use This Page

Use this page if your integration:

• retrieves, updates, or deletes task comments
• sends a message or file to the task discussion
• handles comment events
• works with task results created from comments
• places widgets in the task card

If the integration only creates, updates, retrieves, or deletes tasks without working with comments, use the methods in the Tasks section.

Operating ConditionsOperating Conditions

New Task Card WorkflowNew Task Card Workflow

In the new card, a task has a linked chat. A task comment is stored as a message in that chat:

1. Get the task chat identifier using the tasks.task.get method
2. Use the chat identifier in chat methods. If the method accepts DIALOG_ID, pass the value in the chat{CHAT_ID} format, for example chat58
3. Use tasks.task.chat.message.send to send a new message
4. Use the methods from the Chats section to update, delete, and retrieve messages

Identifier MappingIdentifier Mapping

Migration Quick ReferenceMigration Quick Reference

How to Get the Task Chat IdentifierHow to Get the Task Chat Identifier

Old API VersionOld API Version

POST https://{installation_address}/rest/{user_id}/{rest_app_password}/tasks.task.get
        {
            "taskId": 51,
            "select": ["CHAT_ID"]
        }
        

Example response:

{
            "result": {
                "task": {
                    "id": "51",
                    "chatId": 2537,
                    "favorite": "N",
                    "group": [],
                    "action": {}
                }
            }
        }
        

New API VersionNew API Version

Request the fields chat.id, chat.entityId, chat.entityType for the task:

POST https://{installation_address}/rest/api/{user_id}/{rest_app_password}/tasks.task.get
        {
            "id": 51,
            "select": ["id", "chat.id", "chat.entityId", "chat.entityType"]
        }
        

Example response:

{
            "result": {
                "item": {
                    "id": 51,
                    "chat": {
                        "id": 58,
                        "entityId": 51,
                        "entityType": "TASKS_TASK"
                    }
                }
            }
        }
        

EventsEvents

• The event OnTaskCommentAdd works. When working with the new task card, the handler will receive parameters:

  • MESSAGE_ID with the identifier of the message in the task chat
  • TASK_ID with the identifier of the task
  • 'ID' => 0, the comment identifier will be equal to zero

• The events OnTaskCommentUpdate and OnTaskCommentDelete do not work in the new task card.

Task ResultTask Result

• The method tasks.task.result.list works. When working with the new task card, all task results will be returned with the parameter commentId: 0.

• The methods tasks.task.result.addFromComment and tasks.task.result.deleteFromComment do not work in the new task card.

WidgetsWidgets

The locations of the widgets TASK_VIEW_SIDEBAR, TASK_VIEW_TOP_PANEL, TASK_VIEW_TAB are no longer relevant in the new task card. In the new card, all widgets are displayed in a single "Applications" block.

All previously registered widgets continue to work. New widgets can also be registered, and they will be displayed in the "Applications" block.