Working with Keyboards

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

KEYBOARD adds interactive buttons to a message: link navigation, command execution, text substitution in the input field, and other actions.

The keyboard is passed in the KEYBOARD parameter when sending or updating a message: im.message.add, im.message.update.

Minimum Structure

  • KEYBOARD.BUTTONS — array of buttons
  • TEXT — button text
  • one action: LINK or ACTION + ACTION_VALUE or COMMAND

Example of Sending a Message with a Keyboard

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"DIALOG_ID":"chat2725","MESSAGE":"Select an action","KEYBOARD":{"BUTTONS":[{"TEXT":"Open website","LINK":"https://www.example.com/"},{"TYPE":"NEWLINE"},{"TEXT":"Insert command","ACTION":"PUT","ACTION_VALUE":"/help"}]}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.message.add
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"DIALOG_ID":"chat2725","MESSAGE":"Select an action","KEYBOARD":{"BUTTONS":[{"TEXT":"Open website","LINK":"https://www.example.com/"},{"TYPE":"NEWLINE"},{"TEXT":"Insert command","ACTION":"PUT","ACTION_VALUE":"/help"}]},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.message.add
        
try {
            const response = await $b24.callMethod(
                'im.message.add',
                {
                    DIALOG_ID: 'chat2725',
                    MESSAGE: 'Select an action',
                    KEYBOARD: {
                        BUTTONS: [
                            { TEXT: 'Open website', LINK: 'https://www.example.com/' },
                            { TYPE: 'NEWLINE' },
                            { TEXT: 'Insert command', ACTION: 'PUT', ACTION_VALUE: '/help' },
                        ],
                    },
                }
            );
        
            const result = response.getData().result;
            console.log('Created message ID:', result);
        } catch (error) {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'im.message.add',
                    [
                        'DIALOG_ID' => 'chat2725',
                        'MESSAGE' => 'Select an action',
                        'KEYBOARD' => [
                            'BUTTONS' => [
                                ['TEXT' => 'Open website', 'LINK' => 'https://www.example.com/'],
                                ['TYPE' => 'NEWLINE'],
                                ['TEXT' => 'Insert command', 'ACTION' => 'PUT', 'ACTION_VALUE' => '/help'],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Created message ID: ' . $result;
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'im.message.add',
            {
                DIALOG_ID: 'chat2725',
                MESSAGE: 'Select an action',
                KEYBOARD: {
                    BUTTONS: [
                        { TEXT: 'Open website', LINK: 'https://www.example.com/' },
                        { TYPE: 'NEWLINE' },
                        { TEXT: 'Insert command', ACTION: 'PUT', ACTION_VALUE: '/help' },
                    ],
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.message.add',
            [
                'DIALOG_ID' => 'chat2725',
                'MESSAGE' => 'Select an action',
                'KEYBOARD' => [
                    'BUTTONS' => [
                        ['TEXT' => 'Open website', 'LINK' => 'https://www.example.com/'],
                        ['TYPE' => 'NEWLINE'],
                        ['TEXT' => 'Insert command', 'ACTION' => 'PUT', 'ACTION_VALUE' => '/help'],
                    ],
                ],
            ]
        );
        
        print_r($result);

The current documentation on keyboards can be found in the Chatbots 2.0 section:

Continue Learning

Previous
Attachments
Next
Working with Context Menu