> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heylua.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# links

> One or more URLs rendered as preview cards, buttons, or suggestions

`links` presents URLs with a preview where the channel supports one: search results, documentation pages, external resources. The platform teaches this block on every text channel; see [Response formatting](https://docs.heylua.ai/channels/formatting/overview.md).

*Verified against lua-cli 3.33.0.*

## Syntax

```text theme={null}
::: links
![link](https://www.example.com/page-one)
![link](https://www.example.com/page-two)
:::
```

## Fields

| Field | Required | Notes |
| - | - | - |
| `![link](url)` | Yes, one or more | `[label](url)` also works. `https`, `http`, `mailto:`, and `tel:` URLs; any other link is removed. |

## Example

```text theme={null}
::: links
![link](https://docs.example.com/getting-started)
![link](https://docs.example.com/api-reference)
:::
```

![Link preview cards rendered in the web widget](https://mintcdn.com/luaglobal/5airD3u2P6mv3Ovl/images/formatting/links-preview.png?fit=max\&auto=format\&n=5airD3u2P6mv3Ovl\&q=85\&s=5f345f46fe3dda713613e6124d4ad6a6)

links rendered as preview cards in the web widget

## Where it renders

| Channel | Behavior |
| - | - |
| Web widget | Preview cards; plain links when `disablePreviewOnLinks` is set |
| WhatsApp | One message per link with its title, description, and preview image and a **View Link** button |
| Slack | Preview sections with title, description, and a **Read more** link; a link missing either is skipped |
| Teams | **View Link** buttons under a **Related Links** heading |
| RCS | Open-URL suggestions labelled with the hostname, up to 11 shared with `actions` |
| iMessage | Rich links |
| Email (your own address) | Cards under an **Available Links:** heading |
| SMS, Front, email (generated inbox) | The URLs as text lines |
| Messenger, Instagram, MessageBird | Dropped; put the URL in the message text instead |

The messaging channels read every `::: links` block in a reply. On Slack and Teams a `payment` block in the same reply doesn't affect links; it replaces `actions` only.

## See also

* [Response formatting](https://docs.heylua.ai/channels/formatting/overview.md) — the per-channel matrix
* [navigate](https://docs.heylua.ai/channels/formatting/navigate.md) — send the end user to a page on your own site
* [Widget configuration](https://docs.heylua.ai/channels/web-widget/configuration.md) — `disablePreviewOnLinks`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.