LINK Block

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.

The LINK block displays a link with a caption, description, and an optional preview image.

LINK Block

The LINK block is suitable for manually creating a link block in an attachment.

If you specifically need the format of an expanded link preview, use RICH_LINK.

Block Parameters

Name
type

Description

LINK*
string

URL of the link. Absolute URLs (http://, https://) and relative paths from the root of Bitrix are allowed.

NAME
string

Text of the link. If not specified, LINK is displayed.

DESC
string

Description under the link title.

HTML
string

HTML description. If specified, it is used instead of DESC.

PREVIEW
string

URL of the preview image.

WIDTH
integer

Width of the preview in pixels.

HEIGHT
integer

Height of the preview in pixels.

USER_ID
integer

Link to the Bitrix user (internal navigation).

CHAT_ID
integer

Link to the Bitrix chat (internal navigation).

NETWORK_ID
string

Link to the Bitrix24 Network user.

Example

How to Use Examples in Documentation

{
            LINK: {
                PREVIEW: 'https://example.com/bitrix/templates/1c-bitrix-new/images/logo.png',
                WIDTH: 1000,
                HEIGHT: 638,
                NAME: 'Ticket #12345: New API for the "Web Messenger" Module',
                DESC: 'Must be implemented by the release!',
                LINK: 'https://api.bitrix24.com/'
            }
        }
        
[
            'LINK' => [
                'PREVIEW' => 'https://dev.example..com/bitrix/templates/1c-bitrix-new/images/logo.png',
                'WIDTH' => 1000,
                'HEIGHT' => 638,
                'NAME' => 'Ticket #12345: New API for the "Web Messenger" Module',
                'DESC' => 'Must be implemented by the release!',
                'LINK' => 'https://api.bitrix24.com/'
            ]
        ]
        

Continue Learning