LINK Block

The LINK block outputs a link with a title, 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 extended link preview format, 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

Link text. If not specified, LINK is displayed

DESC
string

Description under the link title

HTML
string

HTML description. If provided, 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://bitrix24.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://bitrix24.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

Previous
User Block
Next
Text Block